---
type: api
title: Update the connector status
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-connector-update-status
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-connector-update-status
products:
  - Elasticsearch
---

# Update the connector status

Availability: Preview since 8.12

## Paths

- `PUT` `/_connector/{connector_id}/_status`

#### Path parameters

- `connector_id` (string) — required
  The unique identifier of the connector to be updated

## Authentication

- Api key: `Authorization: <value>`
  Elasticsearch APIs support key-based authentication.
  You must create an API key and use the encoded value in the request header.
  For example:
  
  
  ```
  curl -X GET "${ES_URL}/_cat/indices?v=true" \
    -H "Authorization: ApiKey ${API_KEY}"
  ```
  
  To get API keys, use the `/_security/api_key` APIs.
- Basic: `Authorization: Basic <credentials>`
- Bearer: `Authorization: Bearer <token>`
  Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.
  For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html)

## Request body

`application/json`

- `status` (enum) — required
  Values: `created`, `needs_configuration`, `configured`, `connected`, `error`

## Response

`application/json`

- `result` (enum)
  Values: `created`, `updated`, `deleted`, `not_found`, `noop`
## Code examples

#### Console

```console
PUT _connector/my-connector/_status
{
    "status": "needs_configuration"
}
```

#### JavaScript

```javascript
const response = await client.connector.updateStatus({
  connector_id: "my-connector",
  status: "needs_configuration",
});
```

#### Python

```python
resp = client.connector.update_status(
    connector_id="my-connector",
    status="needs_configuration",
)
```

#### curl

```curl
curl -X PUT "$ELASTICSEARCH_URL/_connector/my-connector/_status" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "needs_configuration"
  }'
```

#### Java

```java
client.connector().updateStatus(u -> u
    .connectorId("my-connector")
    .status(ConnectorStatus.NeedsConfiguration)
);
```

#### PHP

```php
$resp = $client->connector()->updateStatus([
    "connector_id" => "my-connector",
    "body" => [
        "status" => "needs_configuration",
    ],
]);
```

#### Ruby

```ruby
response = client.connector.update_status(
  connector_id: "my-connector",
  body: {
    "status": "needs_configuration"
  }
)
```

## Response examples

#### Connector update status response example1

```json
{
  "result": "updated"
}
```