> This page is also available as Markdown: append .md to its URL. The full index of Sikaru docs is at https://docs.sikaru.ai/llms.txt. Code examples use only operations from the public API reference at https://docs.sikaru.ai/api-reference.

# Enable

POST https://api.sikaru.ai/v1/projects/{project_id}/connections/{connection_id}/enable

Reference: https://docs.sikaru.ai/api-reference/connections/enable

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `connection_id` (string, required)
- `project_id` (string, required)

## Response

### 200

Successful Response

- `config` (ConnectionConfig, required)
- `display_name` (string, required)
- `grants` (list of ConnectionGrant, required)
- `id` (string, required)
- `kind` (string, required)
- `owner` (string, required)
- `ownership` (string, required)
- `revocation` (string, required)
- `slug` (string, required)
- `status` (string, required)
- `tools` (list of ConnectionTool, required)
- `version` (integer, required)
- `account_status` (string, optional, nullable)
- `expires_at` (double, optional, nullable)
- `tool_count` (integer, optional, default: 0)
- `tool_load` (ConnectionToolLoad, optional, nullable) — The latest tool discovery: loaded, unchanged, or failed (retry by discovering again).
- `used_by` (ConnectionUsage, optional)

## Errors

### 401 Unauthorized Error

Missing or invalid credentials (`unauthenticated`).

- `code` (string, required) — Stable machine code. Specific values: `insufficient_credits` (402): billing does not allow this request now; check your plan, credits and the agent's spending cap; `idempotency_conflict` (409): the idempotency key was already used for a different request, or for a file that was deleted; `concurrent_request` (409): another request is changing the same resource; send the same request again; `agent_disabled` (409): the agent is turned off; turn it on before starting new work; `release_unavailable` (409): the agent has no release that can run; `action_not_pending` (409): the tool call or approval is not waiting for this input: it already has an outcome, its run finished, it is handled by Sikaru, or it does not match a pending request; `not_retryable` (409): the run cannot be retried: it did not fail, its failure is not recoverable, or it failed too long ago; `branch_unavailable` (409): the session cannot be branched at that run; `record_invalid` (409): the retained record cannot be read; `state_conflict` (409): the request conflicts with the resource's current state; read it before trying again; `agent_capacity_full` (429): the agent's turn capacity is full; `agent_unavailable` (503): execution is switched off for this agent; `turn_delivery_pending` (503): the message was recorded but has not started; send it again with the same idempotency key; `execution_storage_unavailable` (503): session, file or workspace storage is unavailable right now; `storage_unavailable` (503): the storage behind this resource is unavailable right now; `trajectory_storage_unavailable` (503): retained run records cannot be read right now. Otherwise a status default: `bad_request` (400), `unauthenticated` (401), `payment_required` (402), `forbidden` (403), `not_found` (404), `method_not_allowed` (405), `not_acceptable` (406), `request_timeout` (408), `conflict` (409), `gone` (410), `length_required` (411), `precondition_failed` (412), `payload_too_large` (413), `unsupported_media_type` (415), `range_not_satisfiable` (416), `invalid_request` (422), `locked` (423), `precondition_required` (428), `rate_limited` (429), `internal_error` (500), `not_implemented` (501), `bad_gateway` (502), `service_unavailable` (503), `gateway_timeout` (504). `429` and `503` refusals with a specific code carry `Retry-After` in seconds.
- `detail` (string, required)

### 403 Forbidden Error

The credential lacks access or a required scope (`forbidden`).

- `code` (string, required) — Stable machine code. Specific values: `insufficient_credits` (402): billing does not allow this request now; check your plan, credits and the agent's spending cap; `idempotency_conflict` (409): the idempotency key was already used for a different request, or for a file that was deleted; `concurrent_request` (409): another request is changing the same resource; send the same request again; `agent_disabled` (409): the agent is turned off; turn it on before starting new work; `release_unavailable` (409): the agent has no release that can run; `action_not_pending` (409): the tool call or approval is not waiting for this input: it already has an outcome, its run finished, it is handled by Sikaru, or it does not match a pending request; `not_retryable` (409): the run cannot be retried: it did not fail, its failure is not recoverable, or it failed too long ago; `branch_unavailable` (409): the session cannot be branched at that run; `record_invalid` (409): the retained record cannot be read; `state_conflict` (409): the request conflicts with the resource's current state; read it before trying again; `agent_capacity_full` (429): the agent's turn capacity is full; `agent_unavailable` (503): execution is switched off for this agent; `turn_delivery_pending` (503): the message was recorded but has not started; send it again with the same idempotency key; `execution_storage_unavailable` (503): session, file or workspace storage is unavailable right now; `storage_unavailable` (503): the storage behind this resource is unavailable right now; `trajectory_storage_unavailable` (503): retained run records cannot be read right now. Otherwise a status default: `bad_request` (400), `unauthenticated` (401), `payment_required` (402), `forbidden` (403), `not_found` (404), `method_not_allowed` (405), `not_acceptable` (406), `request_timeout` (408), `conflict` (409), `gone` (410), `length_required` (411), `precondition_failed` (412), `payload_too_large` (413), `unsupported_media_type` (415), `range_not_satisfiable` (416), `invalid_request` (422), `locked` (423), `precondition_required` (428), `rate_limited` (429), `internal_error` (500), `not_implemented` (501), `bad_gateway` (502), `service_unavailable` (503), `gateway_timeout` (504). `429` and `503` refusals with a specific code carry `Retry-After` in seconds.
- `detail` (string, required)

### 404 Not Found Error

The resource or route does not exist (`not_found`).

- `code` (string, required) — Stable machine code. Specific values: `insufficient_credits` (402): billing does not allow this request now; check your plan, credits and the agent's spending cap; `idempotency_conflict` (409): the idempotency key was already used for a different request, or for a file that was deleted; `concurrent_request` (409): another request is changing the same resource; send the same request again; `agent_disabled` (409): the agent is turned off; turn it on before starting new work; `release_unavailable` (409): the agent has no release that can run; `action_not_pending` (409): the tool call or approval is not waiting for this input: it already has an outcome, its run finished, it is handled by Sikaru, or it does not match a pending request; `not_retryable` (409): the run cannot be retried: it did not fail, its failure is not recoverable, or it failed too long ago; `branch_unavailable` (409): the session cannot be branched at that run; `record_invalid` (409): the retained record cannot be read; `state_conflict` (409): the request conflicts with the resource's current state; read it before trying again; `agent_capacity_full` (429): the agent's turn capacity is full; `agent_unavailable` (503): execution is switched off for this agent; `turn_delivery_pending` (503): the message was recorded but has not started; send it again with the same idempotency key; `execution_storage_unavailable` (503): session, file or workspace storage is unavailable right now; `storage_unavailable` (503): the storage behind this resource is unavailable right now; `trajectory_storage_unavailable` (503): retained run records cannot be read right now. Otherwise a status default: `bad_request` (400), `unauthenticated` (401), `payment_required` (402), `forbidden` (403), `not_found` (404), `method_not_allowed` (405), `not_acceptable` (406), `request_timeout` (408), `conflict` (409), `gone` (410), `length_required` (411), `precondition_failed` (412), `payload_too_large` (413), `unsupported_media_type` (415), `range_not_satisfiable` (416), `invalid_request` (422), `locked` (423), `precondition_required` (428), `rate_limited` (429), `internal_error` (500), `not_implemented` (501), `bad_gateway` (502), `service_unavailable` (503), `gateway_timeout` (504). `429` and `503` refusals with a specific code carry `Retry-After` in seconds.
- `detail` (string, required)

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### ConnectionConfig

- `allowed_hosts` (list of string, optional)
- `auth` (enum, optional, default: none)
  - Allowed values: `none`, `bearer`, `api_key`, `oauth`
- `endpoint` (string, optional, nullable)
- `header_name` (string, optional, nullable)
- `oauth_client_id` (string, optional, nullable)
- `oauth_scopes` (list of string, optional)
- `toolkit` (string, optional, nullable)

### ConnectionGrant

- `active` (boolean, required)
- `agent_id` (string, required)
- `approval` (string, required)
- `environment` (string, required)
- `id` (string, required)
- `tools` (map from string to string, required)

### ConnectionTool

- `digest` (string, required)
- `input_schema` (map from string to any, required)
- `name` (string, required)
- `description` (string, optional, default: )
- `version` (string, optional, nullable)

### ConnectionToolLoad

The latest tool discovery: loaded, unchanged, or failed (retry by discovering again).

- `at` (double, required)
- `status` (enum, required)
  - Allowed values: `loaded`, `unchanged`, `failed`
- `tool_count` (integer, required)
- `removed` (list of string, optional) — Tools the provider no longer offers.
- `removed_used_by` (list of string, optional) — Agents whose selected tools include a removed tool.

### ConnectionUsage

- `agents` (list of ConnectionAgentUsage, required)
- `count` (integer, required)
- `schedules` (list of string, required)

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `ctx` (ValidationErrorCtx, optional)
- `input` (any, optional)

### ConnectionAgentUsage

- `draft` (boolean, required)
- `draft_valid` (boolean, required)
- `id` (string, required)
- `live` (boolean, required)
- `name` (string, required)
- `slug` (string, required)

### ValidationErrorLocItems

- string
- integer

### ValidationErrorCtx

## Examples

**Response**

```json
{
  "config": {
    "allowed_hosts": [
      "string"
    ],
    "auth": "none",
    "endpoint": "string",
    "header_name": "string",
    "oauth_client_id": "string",
    "oauth_scopes": [
      "string"
    ],
    "toolkit": "string"
  },
  "display_name": "string",
  "grants": [
    {
      "active": true,
      "agent_id": "string",
      "approval": "string",
      "environment": "string",
      "id": "string",
      "tools": {}
    }
  ],
  "id": "string",
  "kind": "string",
  "owner": "string",
  "ownership": "string",
  "revocation": "string",
  "slug": "string",
  "status": "string",
  "tools": [
    {
      "digest": "string",
      "input_schema": {},
      "name": "string",
      "description": "",
      "version": "string"
    }
  ],
  "version": 1,
  "account_status": "string",
  "expires_at": 1.1,
  "tool_count": 0,
  "tool_load": {
    "at": 1.1,
    "status": "loaded",
    "tool_count": 1,
    "removed": [
      "string"
    ],
    "removed_used_by": [
      "string"
    ]
  },
  "used_by": {
    "agents": [
      {
        "draft": true,
        "draft_valid": true,
        "id": "string",
        "live": true,
        "name": "string",
        "slug": "string"
      }
    ],
    "count": 1,
    "schedules": [
      "string"
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.sikaru.ai/v1/projects/project_id/connections/connection_id/enable"

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.sikaru.ai/v1/projects/project_id/connections/connection_id/enable';
const options = {method: 'POST', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sikaru.ai/v1/projects/project_id/connections/connection_id/enable"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sikaru.ai/v1/projects/project_id/connections/connection_id/enable")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sikaru.ai/v1/projects/project_id/connections/connection_id/enable")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.sikaru.ai/v1/projects/project_id/connections/connection_id/enable', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sikaru.ai/v1/projects/project_id/connections/connection_id/enable");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sikaru.ai/v1/projects/project_id/connections/connection_id/enable")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```