Update a connector - Spacefast Docs

Update a connector

Renames a connector, replaces its agent-visible description, or re-fetches its source and rebuilds the tool catalog. Connections and policy rules survive a refresh.

PATCH /v1/connectors/{connectorRef}

Authorization

Authorization Bearer token · header required

Authorization: Bearer <token> with an API key (sfa_ prefix), an OAuth access token, a session token, or a Space machine credential (sfm_ prefix).

or

Authorization OAuth2 access token · header required

OAuth 2.0 with Spacefast scopes. People use the authorization code flow; machines use client credentials.

Scopes: connectors:write

Path parameters

connectorRef string required

Query parameters

team string

Request body

required application/json

Responses

200 Response for status 200

Show properties

Show properties

Connections

Example Request

curl -X PATCH "https://api.spacefast.com/v1/connectors/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string",
  "description": "string",
  "refreshSpec": true,
  "specOverrides": [
    {
      "property1": null,
      "property2": null
    }
  ]
}'

Example Response

{
  "$schema": "http://example.com",
  "data": {
    "slug": "string",
    "title": "string",
    "description": "string",
    "source": "openapi",
    "sourceUrl": "string",
    "firstParty": true,
    "presetId": "string",
    "authMethods": [
      {
        "kind": "api_key",
        "slug": "string",
        "label": "string"
      }
    ],
    "toolCount": -9007199254740991,
    "connections": [
      {
        "id": "string",
        "connector": "string",
        "owner": "team",
        "displayName": "string",
        "description": "string",
        "status": "pending_authorization",
        "credentialConfigured": true,
        "authMethod": "string",
        "scopes": [
          "string"
        ],
        "isDefault": true,
        "toolCount": -9007199254740991,
        "createdBy": "string",
        "lastCheckedAt": "2019-08-24T14:15:22Z",
        "revokedAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "specSyncedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}