v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-27192307552.2 KB
workspaces

Create Service Connector

Creates a service connector.

Args: workspace_name_or_id: Name or ID of the workspace. connector: Service connector to register.

Returns: The created service connector.

Raises: IllegalOperationError: If the workspace or user specified in the service connector does not match the current workspace or authenticated user.

post/api/v1/workspaces/{workspace_name_or_id}/service_connectors

Path parameters

string required
OR
string uuid required

Request body

userstring uuid required
workspacestring uuid required
namestring required
descriptionstring
auth_methodstring required
resource_typesstring[]
resource_idstring nullable
supports_instancesboolean
expires_atstring date-time nullable
expires_skew_toleranceinteger nullable
expiration_secondsinteger nullable
configurationobject
secretsobject
labelsobject

Response

Successful Response

resourcesServiceConnectorResponseResources

Class for all resource models associated with the service connector entity.

idstring uuid required
permission_deniedboolean
namestring required