Enterprise Connectors · API Reference

Connector Instances

Create, update, test, and inspect connector instances.

GET/api/v1/connector-instances

List v1 connector instances

List v1 connector instances for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Query parameters

page	Zero-based page index where supported.
size	Page size where supported.

Responses

200Successful response.

400Invalid request.

401Missing or invalid authentication.

403Forbidden by permission, SKU, or provider-admin policy.

404Resource not found or not in the caller's tenant.

Example request

cURL

curl -X GET "https://api.authspoke.com/api/v1/connector-instances" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

{
  "id": "uuid",
  "status": "OK"
}

POST/api/v1/connector-instances

Create or run v1 connector instances

Create or run v1 connector instances for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Request body

name	string	Display name or operation name where applicable.
status	string	Status or lifecycle value where applicable.
reason	string	Audit reason for governed changes.
metadata	object	Provider or business metadata.
configuration	object	Connector, policy, or resource configuration.

Responses

201Successful response.

400Invalid request.

401Missing or invalid authentication.

403Forbidden by permission, SKU, or provider-admin policy.

404Resource not found or not in the caller's tenant.

Example request

cURL

curl -X POST "https://api.authspoke.com/api/v1/connector-instances" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

{
  "id": "uuid",
  "status": "OK"
}

GET/api/v1/connector-instances/{id}

Get connector instances id

Get connector instances id for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Path parameters

id*	id identifier.

Responses

200Successful response.

400Invalid request.

401Missing or invalid authentication.

403Forbidden by permission, SKU, or provider-admin policy.

404Resource not found or not in the caller's tenant.

Example request

cURL

curl -X GET "https://api.authspoke.com/api/v1/connector-instances/{id}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON

{
  "id": "uuid",
  "status": "OK"
}

PATCH/api/v1/connector-instances/{id}

Update connector instances id

Update connector instances id for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Path parameters

id*	id identifier.

Request body

name	string	Display name or operation name where applicable.
status	string	Status or lifecycle value where applicable.
reason	string	Audit reason for governed changes.
metadata	object	Provider or business metadata.
configuration	object	Connector, policy, or resource configuration.

Responses

200Successful response.

400Invalid request.

401Missing or invalid authentication.

403Forbidden by permission, SKU, or provider-admin policy.

404Resource not found or not in the caller's tenant.

Example request

cURL

curl -X PATCH "https://api.authspoke.com/api/v1/connector-instances/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON

{
  "id": "uuid",
  "status": "OK"
}

DELETE/api/v1/connector-instances/{id}

Delete connector instances id

Delete connector instances id for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Path parameters

id*	id identifier.

Responses

204Deleted or completed with no response body.

400Invalid request.

401Missing or invalid authentication.

403Forbidden by permission, SKU, or provider-admin policy.

404Resource not found or not in the caller's tenant.

Example request

cURL

curl -X DELETE "https://api.authspoke.com/api/v1/connector-instances/{id}" \
  -H "Authorization: Bearer $TOKEN"