Skip to content

API

GET /apikey

List API keys

Responses

Status CodeDescription
200OK

POST /apikey/{apiKeyName}

Generate an API key

Parameters

NameLocationRequiredTypeDescription
apiKeyNamepathtruestringAPI key name

Responses

Status CodeDescription
200OK

DELETE /apikey/{apiKeyName}

Revoke API key

Parameters

NameLocationRequiredTypeDescription
apiKeyNamepathtruestringAPI key name

Responses

Status CodeDescription
200OK

GET /container-registry

List container registries

Responses

Status CodeDescription
200OK

GET /container-registry/{server}

Get container registry credentials

Parameters

NameLocationRequiredTypeDescription
serverpathtruestringContainer Registry server name

Responses

Status CodeDescription
200OK

PUT /container-registry/{server}

Set container registry credentials

Parameters

NameLocationRequiredTypeDescription
serverpathtruestringContainer Registry server name
containerRegistrybodytrueundefinedContainer Registry credentials to set

Responses

Status CodeDescription
201Created

DELETE /container-registry/{server}

Remove a container registry credentials

Parameters

NameLocationRequiredTypeDescription
serverpathtruestringContainer Registry server name

Responses

Status CodeDescription
204No Content

GET /gitprovider

List Git providers

Responses

Status CodeDescription
200OK

PUT /gitprovider

Set Git provider

Parameters

NameLocationRequiredTypeDescription
gitProviderConfigbodytrueundefinedGit provider

Responses

Status CodeDescription
200OK

GET /gitprovider/context/{gitUrl}

Get Git context

Parameters

NameLocationRequiredTypeDescription
gitUrlpathtruestringGit URL

Responses

Status CodeDescription
200OK

GET /gitprovider/for-url/{url}

Get Git provider

Parameters

NameLocationRequiredTypeDescription
urlpathtruestringUrl

Responses

Status CodeDescription
200OK

DELETE /gitprovider/{gitProviderId}

Remove Git provider

Parameters

NameLocationRequiredTypeDescription
gitProviderIdpathtruestringGit provider

Responses

Status CodeDescription
200OK

GET /gitprovider/{gitProviderId}/namespaces

Get Git namespaces

Parameters

NameLocationRequiredTypeDescription
gitProviderIdpathtruestringGit provider

Responses

Status CodeDescription
200OK

GET /gitprovider/{gitProviderId}/user

Get Git context

Parameters

NameLocationRequiredTypeDescription
gitProviderIdpathtruestringGit Provider Id

Responses

Status CodeDescription
200OK

GET /gitprovider/{gitProviderId}/{namespaceId}/repositories

Get Git repositories

Parameters

NameLocationRequiredTypeDescription
gitProviderIdpathtruestringGit provider
namespaceIdpathtruestringNamespace

Responses

Status CodeDescription
200OK

GET /gitprovider/{gitProviderId}/{namespaceId}/{repositoryId}/branches

Get Git repository branches

Parameters

NameLocationRequiredTypeDescription
gitProviderIdpathtruestringGit provider
namespaceIdpathtruestringNamespace
repositoryIdpathtruestringRepository

Responses

Status CodeDescription
200OK

GET /gitprovider/{gitProviderId}/{namespaceId}/{repositoryId}/pull-requests

Get Git repository PRs

Parameters

NameLocationRequiredTypeDescription
gitProviderIdpathtruestringGit provider
namespaceIdpathtruestringNamespace
repositoryIdpathtruestringRepository

Responses

Status CodeDescription
200OK

GET /profile

Get profile data

Responses

Status CodeDescription
200OK

PUT /profile

Set profile data

Parameters

NameLocationRequiredTypeDescription
profileDatabodytrueundefinedProfile data

Responses

Status CodeDescription
201Created

DELETE /profile

Delete profile data

Responses

Status CodeDescription
204No Content

GET /provider

List providers

Responses

Status CodeDescription
200OK

POST /provider/install

Install a provider

Parameters

NameLocationRequiredTypeDescription
providerbodytrueundefinedProvider to install

Responses

Status CodeDescription
200OK

GET /provider/{provider}/target-manifest

Get provider target manifest

Parameters

NameLocationRequiredTypeDescription
providerpathtruestringProvider name

Responses

Status CodeDescription
200OK

POST /provider/{provider}/uninstall

Uninstall a provider

Parameters

NameLocationRequiredTypeDescription
providerpathtruestringProvider to uninstall

Responses

Status CodeDescription
200OK

GET /server/config

Get the server configuration

Responses

Status CodeDescription
200OK

POST /server/config

Set the server configuration

Parameters

NameLocationRequiredTypeDescription
configbodytrueundefinedServer configuration

Responses

Status CodeDescription
200OK

POST /server/network-key

Generate a new authentication key

Responses

Status CodeDescription
200OK

GET /target

List targets

Responses

Status CodeDescription
200OK

PUT /target

Set a target

Parameters

NameLocationRequiredTypeDescription
targetbodytrueundefinedTarget to set

Responses

Status CodeDescription
201Created

DELETE /target/{target}

Remove a target

Parameters

NameLocationRequiredTypeDescription
targetpathtruestringTarget name

Responses

Status CodeDescription
204No Content

GET /workspace

List workspaces

Parameters

NameLocationRequiredTypeDescription
verbosequeryundefinedbooleanVerbose

Responses

Status CodeDescription
200OK

POST /workspace

Create a workspace

Parameters

NameLocationRequiredTypeDescription
workspacebodytrueundefinedCreate workspace

Responses

Status CodeDescription
200OK

GET /workspace/{workspaceId}

Get workspace info

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtruestringWorkspace ID or Name

Responses

Status CodeDescription
200OK

DELETE /workspace/{workspaceId}

Remove workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtruestringWorkspace ID
forcequeryundefinedbooleanForce

Responses

Status CodeDescription
200OK

POST /workspace/{workspaceId}/start

Start workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtruestringWorkspace ID or Name

Responses

Status CodeDescription
200OK

POST /workspace/{workspaceId}/stop

Stop workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtruestringWorkspace ID or Name

Responses

Status CodeDescription
200OK

POST /workspace/{workspaceId}/{projectId}/start

Start project

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtruestringWorkspace ID or Name
projectIdpathtruestringProject ID

Responses

Status CodeDescription
200OK

POST /workspace/{workspaceId}/{projectId}/state

Set project state

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtruestringWorkspace ID or Name
projectIdpathtruestringProject ID
setStatebodytrueundefinedSet State

Responses

Status CodeDescription
200OK

POST /workspace/{workspaceId}/{projectId}/stop

Stop project

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtruestringWorkspace ID or Name
projectIdpathtruestringProject ID

Responses

Status CodeDescription
200OK