Activate a connection by id.

Requires permission matching: connection:activate:default.<name>.

post/connections/{id}/activate

Request

Base URL
https://replace-with-account.api.decodable.co/v1alpha2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://auth.decodable.co/authorize?audience=https://api.decodable.co/
  Token URLhttps://auth.decodable.co/oauth/token
  Scopesactivate:connection
TypeScript
https://skmtc.dev/decodable/apis/decodable-control-plane/docs/connections/:id/activate/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Example:abcd1234

An ID that uniquely identifies a resource.

Query parameters

forceboolean

Flags an operation is performed forcefully

tasksinteger

Example:1

The number of tasks allocated to an object upon activation

response_schema_v'v1' | 'v2'

The response schema version to use. Defaults to v1. When v1, the response will include the schema field. When v2, the response will include the schema_v2 field.

Request body

task_sizestring nullable

A task size identifier.

Response

A connection update response.

Example response

{
  "operator-chaining": "true"
}

Changes

No recorded changes to this operation across all 1 revision of this API.