v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
App Connections

Create a CircleCI Connection.

post/api/v1/app-connections/circleci

Request body

method'api-token' required

The method used to authenticate with CircleCI.

namestring required

The name of the CircleCI Connection to create. Must be slug-friendly.

descriptionstring nullable

An optional description for the CircleCI Connection.

projectIdstring

The ID of the project to create the CircleCI Connection in.

isPlatformManagedCredentialsfalse

Not supported for CircleCI Connections.

gatewayId'null' nullable

Not supported for CircleCI Connections.

gatewayPoolId'null' nullable

Not supported for CircleCI Connections.

isAutoRotationEnabledfalse

Not supported for CircleCI Connections.

rotation'null' nullable

Not supported for CircleCI Connections.

Response

Default Response