API reference¶
Generated from the server's request mappings, so nothing here describes an endpoint the server does not serve. Every call carries HTTP Basic credentials: a username and a personal access token belonging to it; the REST API says how to get one. The document this was rendered from is openapi.yaml.
Dutest API v1¶
Plans, builds, deployments and everything else this server holds, for something that is not a browser.
Authenticate with a personal access token from Tokens in the web
interface, or POST /api/v1/tokens, and send it as HTTP Basic
credentials: your username as the user, the token as the password. The
token must belong to the username sent with it, or the request is
rejected. The token carries the permissions of whoever created it, so
an endpoint that answers 403 to a person answers 403 to their token.
GET /api/v1/provenance/public-key is the one endpoint that needs no
token, because whoever is checking an artifact's signature is not a
user of this server.
When something goes wrong¶
Every failure comes back as {"error": "...", "details": [...]}, with
details filled in only where there is more than one thing wrong. The
codes are the same everywhere: 400 the request could not be read,
401 no usable token, 403 the token's owner may not do this,
404 it is not there or is not visible to them, 409 something is
already in the way, and 422 the request was understood and describes
something this server will not accept — a pipeline that will never
validate, a build that cannot be re-run. A caller that retries a 409
must not retry a 422.
Servers¶
| Description | URL |
|---|---|
| This Dutest server | / |
Audit¶
GET /api/v1/admin/audit¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
actorId |
query | string | No | ||
page |
query | integer | 0 | No | |
size |
query | integer | 50 | No | |
targetId |
query | string | No | ||
targetType |
query | string | No |
Responses
{
"events": [
{
"action": "PROJECT_CREATED",
"actorId": "ca37f8bd-80f8-4121-83d7-cab74d3cbcae",
"actorName": "string",
"actorType": "USER",
"detail": "string",
"id": "e98f333e-717c-4b19-a186-44a486679d34",
"occurredAt": "2022-04-13T15:42:05.901Z",
"outcome": "SUCCEEDED",
"targetId": "891da629-ade5-4374-9542-f2239d4f1554",
"targetName": "string",
"targetType": "PROJECT"
}
],
"hasMore": true,
"page": 0,
"size": 60,
"totalEvents": 237
}
Schema of the response body
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditEventResponse"
}
},
"hasMore": {
"type": "boolean"
},
"page": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"totalEvents": {
"type": "integer",
"format": "int64"
}
}
}
GET /api/v1/admin/audit/actors¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"id": "dd9ad6e6-790e-413b-a47f-872ddc212bd5",
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditActorResponse"
}
}
Users¶
GET /api/v1/admin/groups¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"description": "string",
"id": "cfdeed71-e526-431a-83d4-a6aec3f04719",
"memberCount": 102,
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupResponse"
}
}
POST /api/v1/admin/groups¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"description": "string",
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"name": {
"type": "string"
}
}
}
Responses
{
"description": "string",
"id": "abef5ae8-ff67-4e66-b5e0-1109e44ddc7b",
"memberCount": 126,
"name": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"memberCount": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
}
}
}
DELETE /api/v1/admin/groups/{groupId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
groupId |
path | string | No |
Responses
PATCH /api/v1/admin/groups/{groupId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
groupId |
path | string | No |
Request body
{
"description": "string",
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"description": "string",
"id": "17aa4e55-faed-482c-93cc-b1e3ce32cc86",
"memberCount": 56,
"name": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"memberCount": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
}
}
}
DELETE /api/v1/admin/groups/{groupId}/members/{userId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
groupId |
path | string | No | ||
userId |
path | string | No |
Responses
POST /api/v1/admin/groups/{groupId}/members/{userId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
groupId |
path | string | No | ||
userId |
path | string | No |
Responses
GET /api/v1/admin/users¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"authSource": "LOCAL",
"displayName": "string",
"email": "string",
"enabled": true,
"globalRole": "ADMIN",
"id": "3806e1d0-6c7d-421a-8bca-60be349bed32",
"username": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponse"
}
}
POST /api/v1/admin/users¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"displayName": "string",
"email": "string",
"globalRole": "ADMIN",
"password": "string",
"username": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"displayName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"globalRole": {
"type": "string",
"enum": [
"ADMIN",
"USER"
]
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
Responses
{
"authSource": "LOCAL",
"displayName": "string",
"email": "string",
"enabled": true,
"globalRole": "ADMIN",
"id": "04c5fa76-1242-4f09-8aee-34366158a7ee",
"username": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"authSource": {
"type": "string",
"enum": [
"LOCAL",
"OIDC"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"globalRole": {
"type": "string",
"enum": [
"ADMIN",
"USER"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"username": {
"type": "string"
}
}
}
DELETE /api/v1/admin/users/{userId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
userId |
path | string | No |
Responses
PATCH /api/v1/admin/users/{userId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
userId |
path | string | No |
Request body
{
"displayName": "string",
"email": "string",
"enabled": true,
"globalRole": "ADMIN",
"password": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"displayName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean",
"nullable": true
},
"globalRole": {
"type": "string",
"enum": [
"ADMIN",
"USER"
],
"nullable": true
},
"password": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"authSource": "LOCAL",
"displayName": "string",
"email": "string",
"enabled": true,
"globalRole": "ADMIN",
"id": "ee6868a1-2d31-497d-9281-93a87a785f85",
"username": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"authSource": {
"type": "string",
"enum": [
"LOCAL",
"OIDC"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"globalRole": {
"type": "string",
"enum": [
"ADMIN",
"USER"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"username": {
"type": "string"
}
}
}
POST /api/v1/admin/users/{userId}/disable¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
userId |
path | string | No |
Responses
{
"authSource": "LOCAL",
"displayName": "string",
"email": "string",
"enabled": true,
"globalRole": "ADMIN",
"id": "ebd9c748-7e85-4e73-bf37-629e70662614",
"username": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"authSource": {
"type": "string",
"enum": [
"LOCAL",
"OIDC"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"globalRole": {
"type": "string",
"enum": [
"ADMIN",
"USER"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"username": {
"type": "string"
}
}
}
POST /api/v1/admin/users/{userId}/enable¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
userId |
path | string | No |
Responses
{
"authSource": "LOCAL",
"displayName": "string",
"email": "string",
"enabled": true,
"globalRole": "ADMIN",
"id": "2d2f145e-544e-4df7-8b94-b8f1736bde3f",
"username": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"authSource": {
"type": "string",
"enum": [
"LOCAL",
"OIDC"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"globalRole": {
"type": "string",
"enum": [
"ADMIN",
"USER"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"username": {
"type": "string"
}
}
}
POST /api/v1/admin/users/{userId}/role/{role}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
role |
path | string | No | ||
userId |
path | string | No |
Responses
{
"authSource": "LOCAL",
"displayName": "string",
"email": "string",
"enabled": true,
"globalRole": "ADMIN",
"id": "0e7cf691-3503-45d4-88c4-578ff1bccf7f",
"username": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"authSource": {
"type": "string",
"enum": [
"LOCAL",
"OIDC"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"globalRole": {
"type": "string",
"enum": [
"ADMIN",
"USER"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"username": {
"type": "string"
}
}
}
Scheduled jobs¶
GET /api/v1/admin/scheduled-jobs¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"description": "string",
"key": "string",
"lastDurationSeconds": 200,
"lastRunAt": "2022-04-13T15:42:05.901Z",
"nextDueAt": "2022-04-13T15:42:05.901Z",
"periodSeconds": 109,
"ranOn": "string",
"runnable": true,
"running": true,
"title": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduledJobResponse"
}
}
GET /api/v1/admin/scheduled-jobs/{key}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
key |
path | string | No |
Responses
{
"description": "string",
"key": "string",
"lastDurationSeconds": 204,
"lastRunAt": "2022-04-13T15:42:05.901Z",
"nextDueAt": "2022-04-13T15:42:05.901Z",
"periodSeconds": 30,
"ranOn": "string",
"runnable": true,
"running": true,
"title": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"key": {
"type": "string"
},
"lastDurationSeconds": {
"type": "integer",
"format": "int64",
"nullable": true
},
"lastRunAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nextDueAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodSeconds": {
"type": "integer",
"format": "int64"
},
"ranOn": {
"type": "string",
"nullable": true
},
"runnable": {
"type": "boolean"
},
"running": {
"type": "boolean"
},
"title": {
"type": "string"
}
}
}
POST /api/v1/admin/scheduled-jobs/{key}/run¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
key |
path | string | No |
Responses
{
"description": "string",
"key": "string",
"lastDurationSeconds": 171,
"lastRunAt": "2022-04-13T15:42:05.901Z",
"nextDueAt": "2022-04-13T15:42:05.901Z",
"periodSeconds": 226,
"ranOn": "string",
"runnable": true,
"running": true,
"title": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"key": {
"type": "string"
},
"lastDurationSeconds": {
"type": "integer",
"format": "int64",
"nullable": true
},
"lastRunAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nextDueAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodSeconds": {
"type": "integer",
"format": "int64"
},
"ranOn": {
"type": "string",
"nullable": true
},
"runnable": {
"type": "boolean"
},
"running": {
"type": "boolean"
},
"title": {
"type": "string"
}
}
}
Agents¶
GET /api/v1/agents¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"activeJobs": 128,
"capabilities": {},
"connected": true,
"diskFloorBytes": 198,
"diskFreeBytes": 33,
"diskTotalBytes": 219,
"enabled": true,
"ephemeral": true,
"executors": [
"DOCKER"
],
"id": "3904a3c4-d507-4165-a0a3-aa9064acc32c",
"lastSeenAt": "2022-04-13T15:42:05.901Z",
"name": "string",
"version": "string",
"workspacesLeftBehind": 3,
"workspacesLeftBehindBytes": 279
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentResponse"
}
}
POST /api/v1/agents/enrolment-tokens¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"uses": 134
}
Schema of the request body
{
"type": "object",
"properties": {
"uses": {
"type": "integer",
"format": "int32"
}
}
}
Responses
{
"expiresInMinutes": 246,
"token": "string",
"uses": 17
}
Schema of the response body
{
"type": "object",
"properties": {
"expiresInMinutes": {
"type": "integer",
"format": "int64"
},
"token": {
"type": "string"
},
"uses": {
"type": "integer",
"format": "int32"
}
}
}
DELETE /api/v1/agents/{agentId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
agentId |
path | string | No |
Responses
POST /api/v1/agents/{agentId}/disable¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
agentId |
path | string | No |
Responses
{
"activeJobs": 3,
"capabilities": {},
"connected": true,
"diskFloorBytes": 21,
"diskFreeBytes": 29,
"diskTotalBytes": 44,
"enabled": true,
"ephemeral": true,
"executors": [
"DOCKER"
],
"id": "67eb3bbe-5e76-4cab-8493-ffeaaed1ae1a",
"lastSeenAt": "2022-04-13T15:42:05.901Z",
"name": "string",
"version": "string",
"workspacesLeftBehind": 137,
"workspacesLeftBehindBytes": 298
}
Schema of the response body
{
"type": "object",
"properties": {
"activeJobs": {
"type": "integer",
"format": "int32"
},
"capabilities": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"connected": {
"type": "boolean"
},
"diskFloorBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"diskFreeBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"diskTotalBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"ephemeral": {
"type": "boolean"
},
"executors": {
"type": "array",
"items": {
"type": "string",
"enum": [
"DOCKER",
"NATIVE"
]
},
"uniqueItems": true
},
"id": {
"type": "string",
"format": "uuid"
},
"lastSeenAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string"
},
"version": {
"type": "string",
"nullable": true
},
"workspacesLeftBehind": {
"type": "integer",
"format": "int32"
},
"workspacesLeftBehindBytes": {
"type": "integer",
"format": "int64"
}
}
}
POST /api/v1/agents/{agentId}/enable¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
agentId |
path | string | No |
Responses
{
"activeJobs": 103,
"capabilities": {},
"connected": true,
"diskFloorBytes": 297,
"diskFreeBytes": 137,
"diskTotalBytes": 55,
"enabled": true,
"ephemeral": true,
"executors": [
"DOCKER"
],
"id": "f2d83569-32d8-4c0c-9297-9e9db8e95066",
"lastSeenAt": "2022-04-13T15:42:05.901Z",
"name": "string",
"version": "string",
"workspacesLeftBehind": 74,
"workspacesLeftBehindBytes": 282
}
Schema of the response body
{
"type": "object",
"properties": {
"activeJobs": {
"type": "integer",
"format": "int32"
},
"capabilities": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"connected": {
"type": "boolean"
},
"diskFloorBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"diskFreeBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"diskTotalBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"ephemeral": {
"type": "boolean"
},
"executors": {
"type": "array",
"items": {
"type": "string",
"enum": [
"DOCKER",
"NATIVE"
]
},
"uniqueItems": true
},
"id": {
"type": "string",
"format": "uuid"
},
"lastSeenAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string"
},
"version": {
"type": "string",
"nullable": true
},
"workspacesLeftBehind": {
"type": "integer",
"format": "int32"
},
"workspacesLeftBehindBytes": {
"type": "integer",
"format": "int64"
}
}
}
Builds¶
GET /api/v1/builds¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"branch": "string",
"buildNumber": 267,
"commitSha": "string",
"environmentId": "8b4bbd09-13d3-47a6-95c5-02f5f61f31af",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "a5b8f274-cd2b-471c-a632-3f3afd769fc2",
"planId": "3222a030-d5c6-4443-b4de-75658f12c242",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "55035688-7e0d-4f64-9e45-4d04f6b8f75b",
"rerunCount": 119,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "08db9816-cbd0-421b-9d3e-601b9215ef7a",
"jobs": [
{
"agentId": "2feff71b-1dcd-44e0-98bd-33561836723e",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 21,
"failingSince": 112,
"history": "NEW_FAILURE",
"id": "9e667cbc-5f01-4740-a8e7-4a90d3470e99",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "b758c772-c994-497b-8b1d-d72e02e01223"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "ab486dd3-a359-4d23-872d-b1319cab5829",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 229,
"resources": null,
"resultsIn": "f93d0854-8eb6-476f-8088-6fe85dd008cc",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 36,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 133,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 224,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/BuildResponse"
}
}
GET /api/v1/builds/artifacts/{artifactId}/content¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
artifactId |
path | string | No |
Responses
"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
Schema of the response body
{
"type": "string",
"format": "binary"
}
GET /api/v1/builds/artifacts/{artifactId}/provenance¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
artifactId |
path | string | No |
Responses
{
"algorithm": "string",
"payload": "string",
"publicKey": "string",
"signature": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"algorithm": {
"type": "string"
},
"payload": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"signature": {
"type": "string"
}
}
}
GET /api/v1/builds/jobs/{jobRunId}/artifacts¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
jobRunId |
path | string | No |
Responses
[
{
"contentType": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"id": "3e67fe44-a6f3-4cc1-85e2-ba2a3c2f4a05",
"name": "string",
"path": "string",
"sha256": "string",
"sizeBytes": 61
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtifactResponse"
}
}
GET /api/v1/builds/jobs/{jobRunId}/log¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
jobRunId |
path | string | No | ||
service |
query | string | No |
Responses
"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
Schema of the response body
{
"type": "string",
"format": "binary"
}
POST /api/v1/builds/jobs/{jobRunId}/rerun¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
jobRunId |
path | string | No |
Responses
{
"branch": "string",
"buildNumber": 122,
"commitSha": "string",
"environmentId": "8dcea729-5f06-4eff-9ceb-9a507f680871",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "1d9a5dc9-3a3e-41d2-a7fb-c3d345b931a0",
"planId": "668a14e9-19de-45c2-bb44-8f01e85b020e",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "5914dde9-d5d0-4f3e-b0cc-6e242de48767",
"rerunCount": 270,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "087edce9-a46e-4131-974a-ce77b6fa733c",
"jobs": [
{
"agentId": "d64923d0-d14b-409f-a5d8-28d0c67bbcf8",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 3,
"failingSince": 88,
"history": "NEW_FAILURE",
"id": "73f080ff-59bb-4226-a4ce-b5fc1d296493",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "e73bcdf9-44f4-442a-8399-64aebbff8616"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "968b357d-9af7-42bd-903c-077f1b3e73fb",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 158,
"resources": null,
"resultsIn": "834d1648-18b1-4895-bd12-5fc99243f6de",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 265,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 105,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 86,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"buildNumber": {
"type": "integer",
"format": "int32"
},
"commitSha": {
"type": "string",
"nullable": true
},
"environmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"finishedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"planId": {
"type": "string",
"format": "uuid"
},
"queuedAt": {
"type": "string",
"format": "date-time"
},
"releaseId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rerunCount": {
"type": "integer",
"format": "int32"
},
"rerunOf": {
"allOf": [
{
"$ref": "#/components/schemas/RerunSourceResponse"
}
],
"nullable": true
},
"resultTransition": {
"type": "string",
"enum": [
"FIRST_PASSED",
"FIRST_FAILED",
"BROKEN",
"FIXED",
"STILL_PASSING",
"STILL_FAILING",
"INCOMPLETE"
],
"nullable": true
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageResponse"
},
"nullable": true
},
"startedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"PENDING",
"QUEUED",
"ASSIGNED",
"RUNNING",
"SUCCESS",
"FAILED",
"CANCELLED",
"ERROR",
"SKIPPED"
]
},
"triggerDetail": {
"type": "string",
"nullable": true
},
"triggerType": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
}
}
}
GET /api/v1/builds/jobs/{jobRunId}/resources¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
jobRunId |
path | string | No |
Responses
{
"cpuLimitCores": 10.12,
"diskTotalBytes": 152,
"jobRunId": "284b52cf-cf11-4eec-84bb-fdf9227bf781",
"memoryLimitBytes": 179,
"samples": [
{
"at": "2022-04-13T15:42:05.901Z",
"cpuCores": 10.12,
"diskReadBytesPerSecond": 10.12,
"diskUsedBytes": 80,
"diskWriteBytesPerSecond": 10.12,
"memoryBytes": 142,
"networkRxBytesPerSecond": 10.12,
"networkTxBytesPerSecond": 10.12
}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"cpuLimitCores": {
"type": "number",
"format": "double",
"nullable": true
},
"diskTotalBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"jobRunId": {
"type": "string",
"format": "uuid"
},
"memoryLimitBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"samples": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceSampleResponse"
}
}
}
}
GET /api/v1/builds/provenance/public-key¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
Schema of the response body
{
"type": "object",
"additionalProperties": {
"type": "string"
}
}
POST /api/v1/builds/stages/{stageRunId}/release¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
stageRunId |
path | string | No |
Responses
{
"branch": "string",
"buildNumber": 287,
"commitSha": "string",
"environmentId": "b81a641b-6b13-4fe6-8fad-b9ae1539260a",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "bddd2e40-563e-43b2-82ce-903b67a7dfcf",
"planId": "ac27d1af-8ec1-456b-9606-fc5f2836bca9",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "0147dbb1-30e6-4e13-ac42-4b5b4a26b6af",
"rerunCount": 167,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "3fb52f99-ec9f-44b6-a22a-6807549d257c",
"jobs": [
{
"agentId": "c704d121-2b7a-490c-8f22-ef1a6ff757f0",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 280,
"failingSince": 294,
"history": "NEW_FAILURE",
"id": "4924ce08-2a2f-4707-8b79-4113c74d7a39",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "aec759d8-9dad-4f12-a496-7d3c78a475f2"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "cd8153d2-093c-4c20-b573-4637807369f7",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 86,
"resources": null,
"resultsIn": "2b87be55-bbd7-4371-82bd-e01a7ace3150",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 187,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 152,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 246,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"buildNumber": {
"type": "integer",
"format": "int32"
},
"commitSha": {
"type": "string",
"nullable": true
},
"environmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"finishedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"planId": {
"type": "string",
"format": "uuid"
},
"queuedAt": {
"type": "string",
"format": "date-time"
},
"releaseId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rerunCount": {
"type": "integer",
"format": "int32"
},
"rerunOf": {
"allOf": [
{
"$ref": "#/components/schemas/RerunSourceResponse"
}
],
"nullable": true
},
"resultTransition": {
"type": "string",
"enum": [
"FIRST_PASSED",
"FIRST_FAILED",
"BROKEN",
"FIXED",
"STILL_PASSING",
"STILL_FAILING",
"INCOMPLETE"
],
"nullable": true
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageResponse"
},
"nullable": true
},
"startedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"PENDING",
"QUEUED",
"ASSIGNED",
"RUNNING",
"SUCCESS",
"FAILED",
"CANCELLED",
"ERROR",
"SKIPPED"
]
},
"triggerDetail": {
"type": "string",
"nullable": true
},
"triggerType": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
}
}
}
GET /api/v1/builds/{buildRunId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
buildRunId |
path | string | No |
Responses
{
"branch": "string",
"buildNumber": 223,
"commitSha": "string",
"environmentId": "967f721b-9dd8-41a4-86c3-b08efbf64c1f",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "cea996d9-8675-4ecd-b7ae-18616ce3a38c",
"planId": "fbd2f11e-b8b3-4a55-bdec-6e233dfccfeb",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "554467ee-febe-424e-bfc4-cb6b4752f1d6",
"rerunCount": 13,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "a1b7ab96-695c-42be-9901-b060ed2db877",
"jobs": [
{
"agentId": "ef197e49-3008-4dcb-b990-70ec6f69b7fa",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 232,
"failingSince": 203,
"history": "NEW_FAILURE",
"id": "6adeaea3-ed5c-4848-8980-f7f998c2b2a5",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "b6d67ce4-1f9c-458d-9407-357cc66f1c0a"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "6e8965ca-87ca-4d1b-a4e9-b8d557de2856",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 173,
"resources": null,
"resultsIn": "2a652a2d-8c2e-43b1-9e66-b008e82f77ec",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 44,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 76,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 113,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"buildNumber": {
"type": "integer",
"format": "int32"
},
"commitSha": {
"type": "string",
"nullable": true
},
"environmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"finishedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"planId": {
"type": "string",
"format": "uuid"
},
"queuedAt": {
"type": "string",
"format": "date-time"
},
"releaseId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rerunCount": {
"type": "integer",
"format": "int32"
},
"rerunOf": {
"allOf": [
{
"$ref": "#/components/schemas/RerunSourceResponse"
}
],
"nullable": true
},
"resultTransition": {
"type": "string",
"enum": [
"FIRST_PASSED",
"FIRST_FAILED",
"BROKEN",
"FIXED",
"STILL_PASSING",
"STILL_FAILING",
"INCOMPLETE"
],
"nullable": true
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageResponse"
},
"nullable": true
},
"startedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"PENDING",
"QUEUED",
"ASSIGNED",
"RUNNING",
"SUCCESS",
"FAILED",
"CANCELLED",
"ERROR",
"SKIPPED"
]
},
"triggerDetail": {
"type": "string",
"nullable": true
},
"triggerType": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
}
}
}
POST /api/v1/builds/{buildRunId}/cancel¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
buildRunId |
path | string | No |
Responses
{
"branch": "string",
"buildNumber": 114,
"commitSha": "string",
"environmentId": "d85ba592-6283-4264-bb1e-24f93a8bf6dd",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "93d40668-3ca9-49b4-ae46-38b438d8dc5c",
"planId": "40dd690c-c16c-41b0-8b80-c326d3f25165",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "97d0f99b-053e-43d3-b499-f4e684f2a0d3",
"rerunCount": 47,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "96b899ea-4186-459d-86cd-03b36131ea45",
"jobs": [
{
"agentId": "e9943956-9530-4fa1-a74d-44d1aa37ff5e",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 295,
"failingSince": 69,
"history": "NEW_FAILURE",
"id": "7ff5f64f-d9ae-4b62-8bc7-4bde9d740477",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "fd45cc3e-b265-441d-a854-349402f71713"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "82dd8903-77b6-4cd1-94b5-d0e81383f737",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 118,
"resources": null,
"resultsIn": "13a2170d-2c26-43d2-954b-d70efe77467d",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 158,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 136,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 67,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"buildNumber": {
"type": "integer",
"format": "int32"
},
"commitSha": {
"type": "string",
"nullable": true
},
"environmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"finishedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"planId": {
"type": "string",
"format": "uuid"
},
"queuedAt": {
"type": "string",
"format": "date-time"
},
"releaseId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rerunCount": {
"type": "integer",
"format": "int32"
},
"rerunOf": {
"allOf": [
{
"$ref": "#/components/schemas/RerunSourceResponse"
}
],
"nullable": true
},
"resultTransition": {
"type": "string",
"enum": [
"FIRST_PASSED",
"FIRST_FAILED",
"BROKEN",
"FIXED",
"STILL_PASSING",
"STILL_FAILING",
"INCOMPLETE"
],
"nullable": true
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageResponse"
},
"nullable": true
},
"startedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"PENDING",
"QUEUED",
"ASSIGNED",
"RUNNING",
"SUCCESS",
"FAILED",
"CANCELLED",
"ERROR",
"SKIPPED"
]
},
"triggerDetail": {
"type": "string",
"nullable": true
},
"triggerType": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
}
}
}
POST /api/v1/builds/{buildRunId}/rerun¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
buildRunId |
path | string | No |
Request body
{
"scope": "EVERYTHING"
}
Schema of the request body
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"EVERYTHING",
"FAILED_JOBS"
]
}
}
}
Responses
{
"branch": "string",
"buildNumber": 143,
"commitSha": "string",
"environmentId": "e69e1120-e0b0-4e74-a256-d2adcb70673f",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "2e65c1a3-bee7-4bf0-aa1c-ebe35499fca6",
"planId": "358a46ba-7253-4649-b02b-b02a67b3e513",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "459ad688-da51-4c4c-838c-e3b3e03b16fb",
"rerunCount": 222,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "fcf369ad-570c-4aa5-9664-2411c1973149",
"jobs": [
{
"agentId": "eda369fd-0973-4854-95bf-2a26a739885d",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 164,
"failingSince": 111,
"history": "NEW_FAILURE",
"id": "48a00128-cc78-4b01-b4db-d6e6db9b3fd4",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "86bad96f-877e-420b-a396-137ff9a8cd5d"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "75fe6f94-2d85-4e60-9c3d-9802919ed742",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 293,
"resources": null,
"resultsIn": "ce3f0695-0928-4d0a-9674-40ae9ad0cc48",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 65,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 56,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 100,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"buildNumber": {
"type": "integer",
"format": "int32"
},
"commitSha": {
"type": "string",
"nullable": true
},
"environmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"finishedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"planId": {
"type": "string",
"format": "uuid"
},
"queuedAt": {
"type": "string",
"format": "date-time"
},
"releaseId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rerunCount": {
"type": "integer",
"format": "int32"
},
"rerunOf": {
"allOf": [
{
"$ref": "#/components/schemas/RerunSourceResponse"
}
],
"nullable": true
},
"resultTransition": {
"type": "string",
"enum": [
"FIRST_PASSED",
"FIRST_FAILED",
"BROKEN",
"FIXED",
"STILL_PASSING",
"STILL_FAILING",
"INCOMPLETE"
],
"nullable": true
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageResponse"
},
"nullable": true
},
"startedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"PENDING",
"QUEUED",
"ASSIGNED",
"RUNNING",
"SUCCESS",
"FAILED",
"CANCELLED",
"ERROR",
"SKIPPED"
]
},
"triggerDetail": {
"type": "string",
"nullable": true
},
"triggerType": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
}
}
}
Deployments¶
POST /api/v1/deployments/runs/{buildRunId}/rerun¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
buildRunId |
path | string | No |
Request body
{
"scope": "EVERYTHING"
}
Schema of the request body
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"EVERYTHING",
"FAILED_JOBS"
]
}
}
}
Responses
{
"branch": "string",
"buildNumber": 228,
"commitSha": "string",
"environmentId": "b33d3ab5-7a41-4072-a4d0-4422784a60e4",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "730f4ab2-0ac1-4105-b3eb-64c766987a30",
"planId": "2d3e98b9-f1a5-49ad-b74b-37fa4d0da9ff",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "58edd69a-cfa6-4303-bb0b-acdd0d70029e",
"rerunCount": 79,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "ab81db49-c0cc-4609-b610-3b0f06dd9e40",
"jobs": [
{
"agentId": "248d8314-9466-46e2-a03c-c82eb1032f28",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 165,
"failingSince": 262,
"history": "NEW_FAILURE",
"id": "c11e2639-b7f4-44a8-9263-19d81f24d22c",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "30664ac2-6edc-4820-acf4-b0d05e96ee14"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "6d945417-f69b-46ac-b084-529352b210eb",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 21,
"resources": null,
"resultsIn": "fe1409f4-e752-477d-b82a-b4404fbec0c7",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 127,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 231,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 135,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"buildNumber": {
"type": "integer",
"format": "int32"
},
"commitSha": {
"type": "string",
"nullable": true
},
"environmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"finishedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"planId": {
"type": "string",
"format": "uuid"
},
"queuedAt": {
"type": "string",
"format": "date-time"
},
"releaseId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rerunCount": {
"type": "integer",
"format": "int32"
},
"rerunOf": {
"allOf": [
{
"$ref": "#/components/schemas/RerunSourceResponse"
}
],
"nullable": true
},
"resultTransition": {
"type": "string",
"enum": [
"FIRST_PASSED",
"FIRST_FAILED",
"BROKEN",
"FIXED",
"STILL_PASSING",
"STILL_FAILING",
"INCOMPLETE"
],
"nullable": true
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageResponse"
},
"nullable": true
},
"startedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"PENDING",
"QUEUED",
"ASSIGNED",
"RUNNING",
"SUCCESS",
"FAILED",
"CANCELLED",
"ERROR",
"SKIPPED"
]
},
"triggerDetail": {
"type": "string",
"nullable": true
},
"triggerType": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
}
}
}
DELETE /api/v1/deployments/{deploymentProjectId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
deploymentProjectId |
path | string | No |
Responses
GET /api/v1/deployments/{deploymentProjectId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
deploymentProjectId |
path | string | No |
Responses
{
"autoReleaseBranch": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"description": "string",
"id": "274ee2d1-4cde-40d3-8e4d-46f474bdfe32",
"key": "string",
"name": "string",
"nextVersion": "string",
"planId": "05480b14-a6ef-481c-bfec-d1b7526214cc",
"versionScheme": "MANUAL"
}
Schema of the response body
{
"type": "object",
"properties": {
"autoReleaseBranch": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"nextVersion": {
"type": "string",
"nullable": true
},
"planId": {
"type": "string",
"format": "uuid"
},
"versionScheme": {
"type": "string",
"enum": [
"MANUAL",
"INCREMENTING",
"SEMANTIC"
]
}
}
}
PATCH /api/v1/deployments/{deploymentProjectId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
deploymentProjectId |
path | string | No |
Request body
{
"autoReleaseBranch": "string",
"clearAutoRelease": true,
"clearDescription": true,
"description": "string",
"name": "string",
"nextVersion": "string",
"versionScheme": "MANUAL"
}
Schema of the request body
{
"type": "object",
"properties": {
"autoReleaseBranch": {
"type": "string",
"nullable": true
},
"clearAutoRelease": {
"type": "boolean"
},
"clearDescription": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"nextVersion": {
"type": "string",
"nullable": true
},
"versionScheme": {
"type": "string",
"enum": [
"MANUAL",
"INCREMENTING",
"SEMANTIC"
],
"nullable": true
}
}
}
Responses
{
"autoReleaseBranch": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"description": "string",
"id": "2330342a-b1b2-4be5-b15a-5d249339d397",
"key": "string",
"name": "string",
"nextVersion": "string",
"planId": "4ecc4d10-5b6b-4a3a-8cd0-0290df9112be",
"versionScheme": "MANUAL"
}
Schema of the response body
{
"type": "object",
"properties": {
"autoReleaseBranch": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"nextVersion": {
"type": "string",
"nullable": true
},
"planId": {
"type": "string",
"format": "uuid"
},
"versionScheme": {
"type": "string",
"enum": [
"MANUAL",
"INCREMENTING",
"SEMANTIC"
]
}
}
}
GET /api/v1/deployments/{deploymentProjectId}/environments¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
deploymentProjectId |
path | string | No |
Responses
[
{
"deployOnRelease": true,
"deploymentProjectId": "590c9ffc-9c92-40d5-a14f-6a61be4bc80b",
"id": "31b57bda-111f-49d2-99b3-53ea2618d599",
"key": "string",
"name": "string",
"nextDeploymentNumber": 138,
"position": 238,
"promoteAfterEnvironmentId": "5ba7f173-7a9f-4785-9aca-d206e2b020bb",
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentResponse"
}
}
POST /api/v1/deployments/{deploymentProjectId}/environments¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
deploymentProjectId |
path | string | No |
Request body
{
"deployOnRelease": true,
"key": "string",
"name": "string",
"position": 105,
"promoteAfterEnvironmentId": "d7d33ec8-f252-4af2-b014-34d60fd9532b",
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"deployOnRelease": {
"type": "boolean"
},
"key": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"position": {
"type": "integer",
"format": "int32"
},
"promoteAfterEnvironmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"specPath": {
"type": "string",
"nullable": true
},
"specSource": {
"type": "string",
"enum": [
"REPO_YAML",
"STORED"
]
},
"specYaml": {
"type": "string",
"nullable": true
}
},
"required": [
"key",
"name"
]
}
Responses
{
"deployOnRelease": true,
"deploymentProjectId": "55d5b316-6020-4321-bf10-0eaeaa1eb9b6",
"id": "34e65efc-32c0-4ba8-9ec5-a979971242ea",
"key": "string",
"name": "string",
"nextDeploymentNumber": 34,
"position": 197,
"promoteAfterEnvironmentId": "0e4c996e-0dad-44f0-8c83-d6085b6ebc89",
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"deployOnRelease": {
"type": "boolean"
},
"deploymentProjectId": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"nextDeploymentNumber": {
"type": "integer",
"format": "int32"
},
"position": {
"type": "integer",
"format": "int32"
},
"promoteAfterEnvironmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"specPath": {
"type": "string",
"nullable": true
},
"specSource": {
"type": "string",
"enum": [
"REPO_YAML",
"STORED"
]
},
"specYaml": {
"type": "string",
"nullable": true
}
}
}
GET /api/v1/deployments/{deploymentProjectId}/releases¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
deploymentProjectId |
path | string | No |
Responses
[
{
"buildRunId": "eba5619c-5d5b-4aae-b8f1-433c485b7d80",
"createdAt": "2022-04-13T15:42:05.901Z",
"deploymentProjectId": "bd9aedfb-4550-46c1-9b65-c00583fbb6cc",
"id": "fa15fa4c-b993-402e-a0ef-0be3ccb48719",
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseResponse"
}
}
POST /api/v1/deployments/{deploymentProjectId}/releases¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
deploymentProjectId |
path | string | No |
Request body
{
"buildRunId": "8d62a8f4-a46f-45e4-ae8d-df957d80ee7e",
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"buildRunId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"buildRunId": "11031405-835d-402d-84e2-4baa54bc6930",
"createdAt": "2022-04-13T15:42:05.901Z",
"deploymentProjectId": "968a45c6-6a70-4f06-bbf3-2bf1aabc7d10",
"id": "657deb03-8ca1-466e-8f90-946686ba62db",
"name": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"buildRunId": {
"type": "string",
"format": "uuid"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"deploymentProjectId": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
}
}
DELETE /api/v1/environments/{environmentId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
environmentId |
path | string | No |
Responses
PATCH /api/v1/environments/{environmentId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
environmentId |
path | string | No |
Request body
{
"clearPromotion": true,
"deployOnRelease": true,
"name": "string",
"position": 80,
"promoteAfterEnvironmentId": "00e3f9d3-754a-458f-b9da-5036bf8a4484",
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"clearPromotion": {
"type": "boolean"
},
"deployOnRelease": {
"type": "boolean",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"format": "int32",
"nullable": true
},
"promoteAfterEnvironmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"specPath": {
"type": "string",
"nullable": true
},
"specSource": {
"type": "string",
"enum": [
"REPO_YAML",
"STORED"
],
"nullable": true
},
"specYaml": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"deployOnRelease": true,
"deploymentProjectId": "9cfff4dc-11ed-473a-a2ea-414a5083cfaa",
"id": "eddb9e3c-b3d7-4321-88af-d460190e0eeb",
"key": "string",
"name": "string",
"nextDeploymentNumber": 79,
"position": 269,
"promoteAfterEnvironmentId": "1edfb6d1-fb29-4b35-a2ad-9566c7a01f9d",
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"deployOnRelease": {
"type": "boolean"
},
"deploymentProjectId": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"nextDeploymentNumber": {
"type": "integer",
"format": "int32"
},
"position": {
"type": "integer",
"format": "int32"
},
"promoteAfterEnvironmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"specPath": {
"type": "string",
"nullable": true
},
"specSource": {
"type": "string",
"enum": [
"REPO_YAML",
"STORED"
]
},
"specYaml": {
"type": "string",
"nullable": true
}
}
}
POST /api/v1/environments/{environmentId}/deploy¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
environmentId |
path | string | No |
Request body
{
"releaseId": "f53dc47c-3a57-43b3-a95e-40e3ab261823"
}
Schema of the request body
{
"type": "object",
"properties": {
"releaseId": {
"type": "string",
"format": "uuid"
}
}
}
Responses
{
"branch": "string",
"buildNumber": 286,
"commitSha": "string",
"environmentId": "db09228a-5f49-4602-aeda-05c89cba28bf",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "b6680b3f-ca08-4492-ac64-363672cb00c2",
"planId": "ac24bfe4-67ba-47f5-8e91-0a7956bc9b19",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "1267276b-7ae2-4cbe-a2e5-93f92c6dca0c",
"rerunCount": 27,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "6e57d586-ebaa-4836-a640-15ddef65b38c",
"jobs": [
{
"agentId": "22e5d593-8ac3-44de-9380-c3a51979e6f6",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 152,
"failingSince": 196,
"history": "NEW_FAILURE",
"id": "1d83a92d-3f54-4aaf-bba1-846ed0c69267",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "60236107-7074-49b8-a098-8a193d8e7a8b"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "d862ead9-ae53-4be8-ad30-db9645f65699",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 66,
"resources": null,
"resultsIn": "d40787f1-d61c-4cf9-b065-0c3a8735f1e5",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 83,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 81,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 236,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"buildNumber": {
"type": "integer",
"format": "int32"
},
"commitSha": {
"type": "string",
"nullable": true
},
"environmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"finishedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"planId": {
"type": "string",
"format": "uuid"
},
"queuedAt": {
"type": "string",
"format": "date-time"
},
"releaseId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rerunCount": {
"type": "integer",
"format": "int32"
},
"rerunOf": {
"allOf": [
{
"$ref": "#/components/schemas/RerunSourceResponse"
}
],
"nullable": true
},
"resultTransition": {
"type": "string",
"enum": [
"FIRST_PASSED",
"FIRST_FAILED",
"BROKEN",
"FIXED",
"STILL_PASSING",
"STILL_FAILING",
"INCOMPLETE"
],
"nullable": true
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageResponse"
},
"nullable": true
},
"startedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"PENDING",
"QUEUED",
"ASSIGNED",
"RUNNING",
"SUCCESS",
"FAILED",
"CANCELLED",
"ERROR",
"SKIPPED"
]
},
"triggerDetail": {
"type": "string",
"nullable": true
},
"triggerType": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
}
}
}
GET /api/v1/environments/{environmentId}/deployments¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
environmentId |
path | string | No |
Responses
[
{
"branch": "string",
"buildNumber": 200,
"commitSha": "string",
"environmentId": "4112922b-3c04-483d-8c67-92a0cd8f291c",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "44114917-bf90-43ac-9ad7-4c449acdb9e4",
"planId": "2613b26a-32a6-401a-8e32-484c15d6d15c",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "082cd340-7b44-49ad-86d8-ef4e806a3e50",
"rerunCount": 101,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "0c366a0b-675b-48e2-b991-4dd46d9d8890",
"jobs": [
{
"agentId": "f00d2b2b-672e-4d4a-8fcc-64cd3c050b39",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 28,
"failingSince": 154,
"history": "NEW_FAILURE",
"id": "9ff5c4a7-803f-495b-b436-dd8a609d3d3c",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "15fe32ea-6519-456c-b6e5-2a3432e0c115"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "c8b4e0d0-b335-448a-a8c1-06e8838be5ab",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 200,
"resources": null,
"resultsIn": "e098cb2a-6ff0-407e-8550-2455390ccce1",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 51,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 49,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 210,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/BuildResponse"
}
}
GET /api/v1/plans/{planId}/deployments¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Responses
[
{
"autoReleaseBranch": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"description": "string",
"id": "4f2d8f05-c509-411c-ad80-f51f606e71a9",
"key": "string",
"name": "string",
"nextVersion": "string",
"planId": "88812e41-d9ad-4a23-9031-8ee910cfd2b7",
"versionScheme": "MANUAL"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DeploymentProjectResponse"
}
}
POST /api/v1/plans/{planId}/deployments¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Request body
{
"description": "string",
"key": "string",
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"key": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": [
"key",
"name"
]
}
Responses
{
"autoReleaseBranch": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"description": "string",
"id": "94ef0d3e-a470-47c6-9a3a-58ad32da7b8a",
"key": "string",
"name": "string",
"nextVersion": "string",
"planId": "663b3581-56e1-4f73-b568-02bcad8c0d0c",
"versionScheme": "MANUAL"
}
Schema of the response body
{
"type": "object",
"properties": {
"autoReleaseBranch": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"nextVersion": {
"type": "string",
"nullable": true
},
"planId": {
"type": "string",
"format": "uuid"
},
"versionScheme": {
"type": "string",
"enum": [
"MANUAL",
"INCREMENTING",
"SEMANTIC"
]
}
}
}
GET /api/v1/releases/{releaseId}/commits¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
releaseId |
path | string | No |
Responses
{
"commits": [
{
"author": "string",
"committedAt": "2022-04-13T15:42:05.901Z",
"sha": "string",
"subject": "string",
"url": "string"
}
],
"detail": "string",
"reason": "string",
"releaseId": "7f334a3d-924a-4575-a714-4dfe65533f09",
"since": null,
"total": 94,
"wasCut": true
}
Schema of the response body
{
"type": "object",
"properties": {
"commits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleasedCommitResponse"
}
},
"detail": {
"type": "string",
"nullable": true
},
"reason": {
"type": "string",
"nullable": true
},
"releaseId": {
"type": "string",
"format": "uuid"
},
"since": {
"allOf": [
{
"$ref": "#/components/schemas/ReleaseResponse"
}
],
"nullable": true
},
"total": {
"type": "integer",
"format": "int32",
"nullable": true
},
"wasCut": {
"type": "boolean"
}
}
}
Forges¶
GET /api/v1/forges¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"baseUrl": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"id": "24c8c0cd-90bb-4233-a8cb-b4c2f37ede12",
"name": "string",
"type": "FORGEJO",
"updatedAt": "2022-04-13T15:42:05.901Z",
"username": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ForgeConnectionResponse"
}
}
POST /api/v1/forges¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"apiToken": "string",
"baseUrl": "string",
"name": "string",
"type": "FORGEJO"
}
Schema of the request body
{
"type": "object",
"properties": {
"apiToken": {
"type": "string",
"minLength": 1
},
"baseUrl": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"FORGEJO",
"GITHUB",
"BITBUCKET_CLOUD",
"GITLAB"
]
}
},
"required": [
"apiToken",
"baseUrl",
"name"
]
}
Responses
{
"baseUrl": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"id": "5edff0a2-b0f8-4a70-8dc5-7dc4527d4175",
"name": "string",
"type": "FORGEJO",
"updatedAt": "2022-04-13T15:42:05.901Z",
"username": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"FORGEJO",
"GITHUB",
"BITBUCKET_CLOUD",
"GITLAB"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"username": {
"type": "string"
}
}
}
DELETE /api/v1/forges/{connectionId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
connectionId |
path | string | No |
Responses
GET /api/v1/forges/{connectionId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
connectionId |
path | string | No |
Responses
{
"baseUrl": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"id": "3861ddd1-62f5-4919-bfcd-4cf1d4636af8",
"name": "string",
"type": "FORGEJO",
"updatedAt": "2022-04-13T15:42:05.901Z",
"username": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"FORGEJO",
"GITHUB",
"BITBUCKET_CLOUD",
"GITLAB"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"username": {
"type": "string"
}
}
}
PATCH /api/v1/forges/{connectionId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
connectionId |
path | string | No |
Request body
{
"apiToken": "string",
"baseUrl": "string",
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"apiToken": {
"type": "string",
"nullable": true
},
"baseUrl": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"baseUrl": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"id": "8368f7cc-377a-4eb7-8fb8-b833ccd0b5a7",
"name": "string",
"type": "FORGEJO",
"updatedAt": "2022-04-13T15:42:05.901Z",
"username": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"FORGEJO",
"GITHUB",
"BITBUCKET_CLOUD",
"GITLAB"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"username": {
"type": "string"
}
}
}
POST /api/v1/forges/{connectionId}/check¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
connectionId |
path | string | No |
Responses
{
"fullName": "string",
"login": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"fullName": {
"type": "string",
"nullable": true
},
"login": {
"type": "string"
}
}
}
My notifications¶
GET /api/v1/notifications¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
limit |
query | integer | 50 | No |
Responses
[
{
"buildRunId": "462cde72-edc3-431e-8e1d-9b3fe415e82f",
"commitSha": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"id": "f22895cb-6617-42ef-a2ac-df2a96116718",
"kind": "BUILD_SUCCEEDED",
"planId": "013136b4-1073-4b2a-88c4-a6ac12c06acb",
"releaseId": "7daaa9d0-0a70-47bd-b691-75a3cdd0aaa8",
"summary": "string",
"title": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserNotificationResponse"
}
}
POST /api/v1/notifications/addresses¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"address": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"address": {
"type": "string",
"minLength": 1
}
},
"required": [
"address"
]
}
Responses
{
"address": "string",
"id": "b5953cc9-4cfd-49ad-b16d-f4f7c3e217e2"
}
Schema of the response body
{
"type": "object",
"properties": {
"address": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
}
}
}
DELETE /api/v1/notifications/addresses/{identityId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
identityId |
path | string | No |
Responses
DELETE /api/v1/notifications/feed¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
POST /api/v1/notifications/feed¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
{
"url": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
DELETE /api/v1/notifications/mutes/{planId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Responses
POST /api/v1/notifications/mutes/{planId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Responses
GET /api/v1/notifications/preferences¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
{
"addresses": [
{
"address": "string",
"id": "0437417b-fb58-43e2-954b-82c7d47fb043"
}
],
"feedIssuedAt": "2022-04-13T15:42:05.901Z",
"mutedPlanIds": [
"5abc0f32-0f9c-4f39-97e2-01685fb09050"
],
"wanted": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommitAddressResponse"
}
},
"feedIssuedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"mutedPlanIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"wanted": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
}
}
PUT /api/v1/notifications/preferences¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"wanted": {}
}
Schema of the request body
{
"type": "object",
"properties": {
"wanted": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
}
}
Responses
{
"addresses": [
{
"address": "string",
"id": "2d572615-76dd-4840-83b2-bfe19db40613"
}
],
"feedIssuedAt": "2022-04-13T15:42:05.901Z",
"mutedPlanIds": [
"1e038248-1cff-4c2e-9b26-7c997436fc9d"
],
"wanted": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommitAddressResponse"
}
},
"feedIssuedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"mutedPlanIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"wanted": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
}
}
Permissions¶
GET /api/v1/permissions/{targetType}/{targetId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
targetId |
path | string | No | ||
targetType |
path | string | No |
Responses
[
{
"id": "616a5e62-030d-4593-a669-2681846b3ce6",
"permission": "READ",
"subjectId": "1a3e9565-123f-4fb1-97cc-854dfc48421b",
"subjectName": "string",
"subjectType": "USER"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GrantResponse"
}
}
POST /api/v1/permissions/{targetType}/{targetId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
targetId |
path | string | No | ||
targetType |
path | string | No |
Request body
{
"permission": "READ",
"subjectId": "3bbd7b09-f5f6-4cd1-bab0-3bf630b496bf",
"subjectType": "USER"
}
Schema of the request body
{
"type": "object",
"properties": {
"permission": {
"type": "string",
"enum": [
"READ",
"WRITE",
"BUILD",
"ADMIN",
"VIEW",
"DEPLOY",
"EDIT"
]
},
"subjectId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"subjectType": {
"type": "string",
"enum": [
"USER",
"GROUP",
"LOGGED_IN",
"ANONYMOUS"
]
}
}
}
Responses
{
"id": "68ba2b32-4302-4bfd-964b-1f0322778264",
"permission": "READ",
"subjectId": "85f57ade-4519-40a2-a2e4-bc4462ea9a39",
"subjectName": "string",
"subjectType": "USER"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"permission": {
"type": "string",
"enum": [
"READ",
"WRITE",
"BUILD",
"ADMIN",
"VIEW",
"DEPLOY",
"EDIT"
]
},
"subjectId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"subjectName": {
"type": "string"
},
"subjectType": {
"type": "string",
"enum": [
"USER",
"GROUP",
"LOGGED_IN",
"ANONYMOUS"
]
}
}
}
DELETE /api/v1/permissions/{targetType}/{targetId}/{grantId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
grantId |
path | string | No | ||
targetId |
path | string | No | ||
targetType |
path | string | No |
Responses
Plans¶
GET /api/v1/plans¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"branchCleanup": {
"deletedDays": 212,
"inactiveDays": 253
},
"branchDivergence": true,
"concurrency": {
"limit": 28,
"strategy": "UNLIMITED"
},
"description": "string",
"enabled": true,
"id": "58b0f614-efe9-4abe-b51c-31954b72a021",
"key": "string",
"labels": [
"string"
],
"name": "string",
"nextBuildNumber": 258,
"projectId": "dc9cf354-650f-4d23-ba39-69f4d112ff7c",
"repositories": [
{
"branch": "string",
"checkoutDirectory": "string",
"id": "ccacf608-a720-459b-afb9-8cb9cfa7b151",
"position": 162,
"repositoryId": "2f4a9b61-b96d-4c33-9e1f-56e50dd2139b"
}
],
"repositoryId": "8ddb8d22-b70a-4509-9113-8d7b98ca1cb6",
"retention": {
"builds": 174,
"days": 92
},
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanResponse"
}
}
POST /api/v1/plans¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"branchDivergence": true,
"description": "string",
"key": "string",
"name": "string",
"projectId": "db5318fb-7ff9-4306-82c8-f61520952880",
"repositoryId": "0fc9bd98-8a37-44b4-8e04-44d8fe87d432",
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"branchDivergence": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"key": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"format": "uuid"
},
"repositoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"specPath": {
"type": "string",
"nullable": true
},
"specSource": {
"type": "string",
"enum": [
"REPO_YAML",
"STORED"
]
},
"specYaml": {
"type": "string",
"nullable": true
}
},
"required": [
"key",
"name"
]
}
Responses
{
"branchCleanup": {
"deletedDays": 200,
"inactiveDays": 121
},
"branchDivergence": true,
"concurrency": {
"limit": 279,
"strategy": "UNLIMITED"
},
"description": "string",
"enabled": true,
"id": "f5926cba-554f-4366-b737-30eccd5f90ef",
"key": "string",
"labels": [
"string"
],
"name": "string",
"nextBuildNumber": 166,
"projectId": "e38dec0d-8656-4efa-8aef-223744d7b45a",
"repositories": [
{
"branch": "string",
"checkoutDirectory": "string",
"id": "552d54aa-acc5-4448-a581-c278167032ee",
"position": 71,
"repositoryId": "6c177418-1f23-4102-af6a-47a63629a079"
}
],
"repositoryId": "9a5403ba-a7f5-4419-bd80-d930cf9a7f37",
"retention": {
"builds": 38,
"days": 68
},
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"branchCleanup": {
"$ref": "#/components/schemas/BranchCleanupSettings"
},
"branchDivergence": {
"type": "boolean"
},
"concurrency": {
"$ref": "#/components/schemas/ConcurrencySettings"
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"nextBuildNumber": {
"type": "integer",
"format": "int32"
},
"projectId": {
"type": "string",
"format": "uuid"
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanRepositoryResponse"
}
},
"repositoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"retention": {
"$ref": "#/components/schemas/RetentionSettings"
},
"specPath": {
"type": "string"
},
"specSource": {
"type": "string",
"enum": [
"REPO_YAML",
"STORED"
]
},
"specYaml": {
"type": "string",
"nullable": true
}
}
}
DELETE /api/v1/plans/{planId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Responses
GET /api/v1/plans/{planId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Responses
{
"branchCleanup": {
"deletedDays": 258,
"inactiveDays": 33
},
"branchDivergence": true,
"concurrency": {
"limit": 276,
"strategy": "UNLIMITED"
},
"description": "string",
"enabled": true,
"id": "d183e207-7f30-463e-bc06-45bf4b66293e",
"key": "string",
"labels": [
"string"
],
"name": "string",
"nextBuildNumber": 184,
"projectId": "1ebc55c6-bf2a-4567-ba54-4ca34c8e970b",
"repositories": [
{
"branch": "string",
"checkoutDirectory": "string",
"id": "801def17-e660-451c-b9ce-66bf09fea97a",
"position": 31,
"repositoryId": "95af2618-29ec-422c-8e83-59af8eccbd3a"
}
],
"repositoryId": "80b11031-fbba-432c-86c8-eab2238bbd07",
"retention": {
"builds": 192,
"days": 133
},
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"branchCleanup": {
"$ref": "#/components/schemas/BranchCleanupSettings"
},
"branchDivergence": {
"type": "boolean"
},
"concurrency": {
"$ref": "#/components/schemas/ConcurrencySettings"
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"nextBuildNumber": {
"type": "integer",
"format": "int32"
},
"projectId": {
"type": "string",
"format": "uuid"
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanRepositoryResponse"
}
},
"repositoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"retention": {
"$ref": "#/components/schemas/RetentionSettings"
},
"specPath": {
"type": "string"
},
"specSource": {
"type": "string",
"enum": [
"REPO_YAML",
"STORED"
]
},
"specYaml": {
"type": "string",
"nullable": true
}
}
}
PATCH /api/v1/plans/{planId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Request body
{
"branchCleanup": null,
"branchDivergence": true,
"concurrency": null,
"description": "string",
"enabled": true,
"labels": [
"string"
],
"name": "string",
"repositoryId": "147462b6-2718-46d7-a7e6-4f566c5a457f",
"retention": null,
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"branchCleanup": {
"allOf": [
{
"$ref": "#/components/schemas/BranchCleanupSettings"
}
],
"nullable": true
},
"branchDivergence": {
"type": "boolean",
"nullable": true
},
"concurrency": {
"allOf": [
{
"$ref": "#/components/schemas/ConcurrencySettings"
}
],
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"repositoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"retention": {
"allOf": [
{
"$ref": "#/components/schemas/RetentionSettings"
}
],
"nullable": true
},
"specPath": {
"type": "string",
"nullable": true
},
"specSource": {
"type": "string",
"enum": [
"REPO_YAML",
"STORED"
],
"nullable": true
},
"specYaml": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"branchCleanup": {
"deletedDays": 270,
"inactiveDays": 126
},
"branchDivergence": true,
"concurrency": {
"limit": 266,
"strategy": "UNLIMITED"
},
"description": "string",
"enabled": true,
"id": "8e122505-66de-4cf4-8fbe-d93e1a5928f3",
"key": "string",
"labels": [
"string"
],
"name": "string",
"nextBuildNumber": 153,
"projectId": "233fa782-b12b-44ce-8164-82b4589cd6b0",
"repositories": [
{
"branch": "string",
"checkoutDirectory": "string",
"id": "977e5c4c-57b1-483c-8576-ba16512d8b44",
"position": 203,
"repositoryId": "09e25798-447b-410c-bbd3-9008bdf95171"
}
],
"repositoryId": "7835c0ca-f871-4911-8e3d-7a82c33ec6af",
"retention": {
"builds": 266,
"days": 98
},
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"branchCleanup": {
"$ref": "#/components/schemas/BranchCleanupSettings"
},
"branchDivergence": {
"type": "boolean"
},
"concurrency": {
"$ref": "#/components/schemas/ConcurrencySettings"
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"nextBuildNumber": {
"type": "integer",
"format": "int32"
},
"projectId": {
"type": "string",
"format": "uuid"
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanRepositoryResponse"
}
},
"repositoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"retention": {
"$ref": "#/components/schemas/RetentionSettings"
},
"specPath": {
"type": "string"
},
"specSource": {
"type": "string",
"enum": [
"REPO_YAML",
"STORED"
]
},
"specYaml": {
"type": "string",
"nullable": true
}
}
}
GET /api/v1/plans/{planId}/branches¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
liveOnly |
query | boolean | False | No | |
planId |
path | string | No |
Responses
[
{
"firstSeenAt": "2022-04-13T15:42:05.901Z",
"lastBuiltAt": "2022-04-13T15:42:05.901Z",
"latestBuild": null,
"live": true,
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanBranchResponse"
}
}
POST /api/v1/plans/{planId}/build¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Request body
{
"branch": "string",
"commitSha": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"commitSha": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"branch": "string",
"buildNumber": 20,
"commitSha": "string",
"environmentId": "6258f732-c762-43e0-8bf7-25534171a2fd",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "b4048ce5-05e6-47a0-b558-81eba4cb025a",
"planId": "5144255f-6e62-4ab1-938b-9c614ffdf50f",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "042f7ee4-fc9d-42b0-966a-df2a3ebe9ec5",
"rerunCount": 135,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "39863fe7-51bb-4915-9684-b9c51cb1cb11",
"jobs": [
{
"agentId": "9f3ca922-4cfa-483c-936b-f3d932e88a7d",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 80,
"failingSince": 163,
"history": "NEW_FAILURE",
"id": "c372317c-0056-4113-b403-fe8f1383a2c0",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "9cb1932a-627a-4ba0-b441-dcd94f77536a"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "52afd2f3-0e3e-4ec2-a373-5c023716ada7",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 76,
"resources": null,
"resultsIn": "e6c0ecbc-d4ec-4ff2-ab2e-9a55ca535a74",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 280,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 296,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 150,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"buildNumber": {
"type": "integer",
"format": "int32"
},
"commitSha": {
"type": "string",
"nullable": true
},
"environmentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"finishedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"planId": {
"type": "string",
"format": "uuid"
},
"queuedAt": {
"type": "string",
"format": "date-time"
},
"releaseId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rerunCount": {
"type": "integer",
"format": "int32"
},
"rerunOf": {
"allOf": [
{
"$ref": "#/components/schemas/RerunSourceResponse"
}
],
"nullable": true
},
"resultTransition": {
"type": "string",
"enum": [
"FIRST_PASSED",
"FIRST_FAILED",
"BROKEN",
"FIXED",
"STILL_PASSING",
"STILL_FAILING",
"INCOMPLETE"
],
"nullable": true
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageResponse"
},
"nullable": true
},
"startedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"PENDING",
"QUEUED",
"ASSIGNED",
"RUNNING",
"SUCCESS",
"FAILED",
"CANCELLED",
"ERROR",
"SKIPPED"
]
},
"triggerDetail": {
"type": "string",
"nullable": true
},
"triggerType": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
}
}
}
GET /api/v1/plans/{planId}/builds¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
branch |
query | string | No | ||
limit |
query | integer | 25 | No | |
planId |
path | string | No |
Responses
[
{
"branch": "string",
"buildNumber": 155,
"commitSha": "string",
"environmentId": "dcd9c1a8-cb08-4bf8-b2b1-85581cd7349a",
"errorMessage": "string",
"finishedAt": "2022-04-13T15:42:05.901Z",
"id": "d486b929-9940-494a-9b49-9fdf5ae18fc4",
"planId": "b72ad7aa-6181-45f2-add7-16506cec86e9",
"queuedAt": "2022-04-13T15:42:05.901Z",
"releaseId": "9282881d-92fe-45d0-bafd-bc35ecd99cb1",
"rerunCount": 36,
"rerunOf": null,
"resultTransition": "FIRST_PASSED",
"stages": [
{
"id": "b61ec908-02c4-4c84-9f78-266180d611c8",
"jobs": [
{
"agentId": "78ebb8c2-b530-4ad2-a87c-e408339cc892",
"agentName": "string",
"carriedFrom": null,
"consumes": [
{
"fromJob": "string",
"into": "string",
"name": "string"
}
],
"errorMessage": "string",
"failedTests": [
{
"detail": "string",
"durationMillis": 175,
"failingSince": 284,
"history": "NEW_FAILURE",
"id": "76c53cd6-1f84-46c0-8b60-bf5a245828ca",
"message": "string",
"name": "string",
"outcome": "PASSED",
"suite": "string",
"testId": "12f0653e-bb7c-4845-adc0-75397ba700f8"
}
],
"finishedAt": "2022-04-13T15:42:05.901Z",
"fixedTests": [
{
"name": "string",
"suite": "string"
}
],
"id": "2e635367-e406-44d1-b1bd-8a53c7d4a562",
"key": "string",
"name": "string",
"quarantinedTests": null,
"rerunCount": 14,
"resources": null,
"resultsIn": "66af6575-052d-4c5b-8912-554e6c58fde1",
"runtimeImage": "string",
"runtimeType": "DOCKER",
"services": [
{
"image": "string",
"name": "string"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"steps": [
{
"exitCode": 162,
"finishedAt": "2022-04-13T15:42:05.901Z",
"index": 11,
"kind": "CHECKOUT",
"name": "string",
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING"
}
],
"tests": null
}
],
"manual": true,
"name": "string",
"position": 66,
"status": "PENDING"
}
],
"startedAt": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"triggerDetail": "string",
"triggerType": "WEBHOOK"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/BuildResponse"
}
}
GET /api/v1/plans/{planId}/repositories¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Responses
[
{
"branch": "string",
"checkoutDirectory": "string",
"id": "e9a4c049-7134-4d86-aeab-7074d801c675",
"position": 189,
"repositoryId": "a928864b-b61b-4ffe-aca3-46b69bb4bf25"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanRepositoryResponse"
}
}
POST /api/v1/plans/{planId}/repositories¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Request body
{
"branch": "string",
"checkoutDirectory": "string",
"repositoryId": "d3126bd9-6bb4-459d-9630-000b1a092682"
}
Schema of the request body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"checkoutDirectory": {
"type": "string",
"nullable": true
},
"repositoryId": {
"type": "string",
"format": "uuid"
}
}
}
Responses
{
"branch": "string",
"checkoutDirectory": "string",
"id": "d556ff63-bd01-4c0a-ad23-a6fdc0ff0854",
"position": 71,
"repositoryId": "0443f8f7-d428-4503-aa3b-92f98f83d27c"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"checkoutDirectory": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"position": {
"type": "integer",
"format": "int32"
},
"repositoryId": {
"type": "string",
"format": "uuid"
}
}
}
DELETE /api/v1/plans/{planId}/repositories/{checkoutId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
checkoutId |
path | string | No | ||
planId |
path | string | No |
Responses
Plan notifications¶
GET /api/v1/plans/{planId}/notifications¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Responses
[
{
"channel": "EMAIL",
"enabled": true,
"event": "ALL",
"id": "1337a735-da34-4210-9831-20187ba578f2",
"target": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationResponse"
}
}
POST /api/v1/plans/{planId}/notifications¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Request body
{
"channel": "EMAIL",
"event": "ALL",
"target": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"EMAIL",
"WEBHOOK"
]
},
"event": {
"type": "string",
"enum": [
"ALL",
"FAILED",
"STATUS_CHANGED"
]
},
"target": {
"type": "string",
"minLength": 1
}
},
"required": [
"target"
]
}
Responses
{
"channel": "EMAIL",
"enabled": true,
"event": "ALL",
"id": "abaf255d-b2a8-4ac9-9dc0-b0e0b1d40e06",
"target": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"EMAIL",
"WEBHOOK"
]
},
"enabled": {
"type": "boolean"
},
"event": {
"type": "string",
"enum": [
"ALL",
"FAILED",
"STATUS_CHANGED"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"target": {
"type": "string"
}
}
}
DELETE /api/v1/plans/{planId}/notifications/{notificationId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
notificationId |
path | string | No | ||
planId |
path | string | No |
Responses
Quarantine¶
GET /api/v1/plans/{planId}/quarantine¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Responses
[
{
"id": "750f664f-936f-4109-928e-6b7a23d51fa3",
"name": "string",
"reason": "string",
"since": "2022-04-13T15:42:05.901Z",
"suite": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/QuarantinedTestResponse"
}
}
PUT /api/v1/plans/{planId}/quarantine¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Request body
{
"name": "string",
"reason": "string",
"suite": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"reason": {
"type": "string",
"nullable": true
},
"suite": {
"type": "string",
"minLength": 1
}
},
"required": [
"name",
"suite"
]
}
Responses
{
"id": "38dea101-0dce-4795-bd2b-7e63b8a988c4",
"name": "string",
"reason": "string",
"since": "2022-04-13T15:42:05.901Z",
"suite": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"reason": {
"type": "string",
"nullable": true
},
"since": {
"type": "string",
"format": "date-time"
},
"suite": {
"type": "string"
}
}
}
DELETE /api/v1/plans/{planId}/quarantine/{quarantineId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No | ||
quarantineId |
path | string | No |
Responses
Plan triggers¶
GET /api/v1/plans/{planId}/triggers¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Responses
[
{
"branch": "string",
"branches": [
"string"
],
"conditions": [
{
"exclude": [
"string"
],
"include": [
"string"
],
"type": "BRANCH"
}
],
"cron": "string",
"enabled": true,
"id": "c3c11571-f56f-43cd-ae4f-85040f8e8286",
"lastFiredAt": "2022-04-13T15:42:05.901Z",
"nextFireAt": "2022-04-13T15:42:05.901Z",
"source": "PIPELINE",
"type": "WEBHOOK",
"upstreamPlanId": "b80318ba-ce25-4920-bfe8-1b56c678407a"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerResponse"
}
}
POST /api/v1/plans/{planId}/triggers¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No |
Request body
{
"branch": "string",
"branches": [
"string"
],
"conditions": [
{
"exclude": [
"string"
],
"include": [
"string"
],
"type": "BRANCH"
}
],
"cron": "string",
"type": "WEBHOOK",
"upstreamPlanId": "115c0c4f-3394-43f9-9893-6d2d68000aae"
}
Schema of the request body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"branches": {
"type": "array",
"items": {
"type": "string"
}
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionPayload"
}
},
"cron": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
},
"upstreamPlanId": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
}
Responses
{
"branch": "string",
"branches": [
"string"
],
"conditions": [
{
"exclude": [
"string"
],
"include": [
"string"
],
"type": "BRANCH"
}
],
"cron": "string",
"enabled": true,
"id": "c8d0b48d-e019-4db8-b3cb-90576858a800",
"lastFiredAt": "2022-04-13T15:42:05.901Z",
"nextFireAt": "2022-04-13T15:42:05.901Z",
"source": "PIPELINE",
"type": "WEBHOOK",
"upstreamPlanId": "34fd2275-b0cb-46f9-8785-f8522b07191d"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"branches": {
"type": "array",
"items": {
"type": "string"
}
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionPayload"
}
},
"cron": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"lastFiredAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nextFireAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"source": {
"type": "string",
"enum": [
"PIPELINE",
"CONFIGURED"
]
},
"type": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
},
"upstreamPlanId": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
}
DELETE /api/v1/plans/{planId}/triggers/{triggerId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No | ||
triggerId |
path | string | No |
Responses
PATCH /api/v1/plans/{planId}/triggers/{triggerId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
planId |
path | string | No | ||
triggerId |
path | string | No |
Request body
{
"branches": [
"string"
],
"conditions": [
{
"exclude": [
"string"
],
"include": [
"string"
],
"type": "BRANCH"
}
]
}
Schema of the request body
{
"type": "object",
"properties": {
"branches": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionPayload"
},
"nullable": true
}
}
}
Responses
{
"branch": "string",
"branches": [
"string"
],
"conditions": [
{
"exclude": [
"string"
],
"include": [
"string"
],
"type": "BRANCH"
}
],
"cron": "string",
"enabled": true,
"id": "41a3551a-46d4-4d94-bf1a-ab502e5b1ab1",
"lastFiredAt": "2022-04-13T15:42:05.901Z",
"nextFireAt": "2022-04-13T15:42:05.901Z",
"source": "PIPELINE",
"type": "WEBHOOK",
"upstreamPlanId": "8ff54f6f-f891-4342-b89e-ea18ac23f627"
}
Schema of the response body
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"nullable": true
},
"branches": {
"type": "array",
"items": {
"type": "string"
}
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionPayload"
}
},
"cron": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"lastFiredAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nextFireAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"source": {
"type": "string",
"enum": [
"PIPELINE",
"CONFIGURED"
]
},
"type": {
"type": "string",
"enum": [
"WEBHOOK",
"SCHEDULE",
"MANUAL",
"AFTER_PLAN"
]
},
"upstreamPlanId": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
}
Projects¶
GET /api/v1/projects¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"createdAt": "2022-04-13T15:42:05.901Z",
"description": "string",
"id": "9f016d5e-2dc2-4cf6-afe8-51a53882e803",
"key": "string",
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
POST /api/v1/projects¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"description": "string",
"key": "string",
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"key": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": [
"key",
"name"
]
}
Responses
{
"createdAt": "2022-04-13T15:42:05.901Z",
"description": "string",
"id": "c0bd6e33-b535-40b2-b795-12bf06141c96",
"key": "string",
"name": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
DELETE /api/v1/projects/{projectId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
projectId |
path | string | No |
Responses
GET /api/v1/projects/{projectId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
projectId |
path | string | No |
Responses
{
"createdAt": "2022-04-13T15:42:05.901Z",
"description": "string",
"id": "5a3d9c3a-4e0d-496d-a543-4db657aad213",
"key": "string",
"name": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
PATCH /api/v1/projects/{projectId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
projectId |
path | string | No |
Request body
{
"description": "string",
"key": "string",
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"key": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"createdAt": "2022-04-13T15:42:05.901Z",
"description": "string",
"id": "a2051a51-a549-4632-bca7-e19e55acba87",
"key": "string",
"name": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
GET /api/v1/projects/{projectId}/plans¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
projectId |
path | string | No |
Responses
[
{
"branchCleanup": {
"deletedDays": 263,
"inactiveDays": 156
},
"branchDivergence": true,
"concurrency": {
"limit": 222,
"strategy": "UNLIMITED"
},
"description": "string",
"enabled": true,
"id": "4632fc17-9d19-43e3-b3e6-c9dabe28844d",
"key": "string",
"labels": [
"string"
],
"name": "string",
"nextBuildNumber": 219,
"projectId": "f0e5ae37-cb8b-42b5-a93f-f194ff86dcf7",
"repositories": [
{
"branch": "string",
"checkoutDirectory": "string",
"id": "92452a66-069f-4768-b74c-ac590da22382",
"position": 189,
"repositoryId": "9680cb13-c235-4631-9c78-2980d535ec3b"
}
],
"repositoryId": "bc72addf-2566-4b30-9eed-238574dd5e02",
"retention": {
"builds": 267,
"days": 200
},
"specPath": "string",
"specSource": "REPO_YAML",
"specYaml": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanResponse"
}
}
Queue¶
GET /api/v1/queue¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"agentName": "string",
"branch": "string",
"buildNumber": 94,
"buildRunId": "db4aeee6-d956-44c8-997c-85d6f8889aa0",
"environmentName": "string",
"jobKey": "string",
"jobName": "string",
"jobRunId": "d637766f-d3c3-4b7f-b2be-d7e9cc8ca30b",
"planKey": "string",
"reason": "WAITING_FOR_CAPACITY",
"requirements": {},
"resources": {
"cpuCores": 10.12,
"cpuMillicores": 27,
"declared": true,
"description": "string",
"memoryBytes": 122
},
"runtimeType": "DOCKER",
"since": "2022-04-13T15:42:05.901Z",
"status": "PENDING",
"waitingSeconds": 182
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/QueuedJob"
}
}
GET /api/v1/queue/agents¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"agentId": "07820c51-1cbf-4cfe-a3ab-865db27640fb",
"capabilities": {},
"maxConcurrentJobs": 69,
"name": "string",
"runningJobs": 0
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentActivityResponse"
}
}
Repositories¶
GET /api/v1/repositories¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"cloneUrl": "string",
"credentialType": "NONE",
"credentialUsername": "string",
"defaultBranch": "string",
"fetchLfs": true,
"fetchSubmodules": true,
"forgeBaseUrl": "string",
"forgeConnectionId": "1475e999-6670-4329-9d45-37b50cd654fe",
"hasWebhookSecret": true,
"id": "de4720a8-22b9-4d7e-8a9f-97873f5572a6",
"name": "string",
"projectId": "c64cfdbe-231c-4c97-b9a7-ca443e1a80d9",
"remoteFullName": "string",
"type": "GENERIC_GIT",
"webhookUrl": "string",
"webhookUrlPath": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RepositoryResponse"
}
}
POST /api/v1/repositories¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"cloneUrl": "string",
"credentialSecret": "string",
"credentialType": "NONE",
"credentialUsername": "string",
"defaultBranch": "string",
"fetchLfs": true,
"fetchSubmodules": true,
"forgeApiToken": "string",
"forgeBaseUrl": "string",
"name": "string",
"projectId": "ddd922f1-c48c-4597-945e-8504712d7e82",
"type": "GENERIC_GIT"
}
Schema of the request body
{
"type": "object",
"properties": {
"cloneUrl": {
"type": "string",
"minLength": 1
},
"credentialSecret": {
"type": "string",
"nullable": true
},
"credentialType": {
"type": "string",
"enum": [
"NONE",
"USERNAME_PASSWORD",
"SSH_KEY"
]
},
"credentialUsername": {
"type": "string",
"nullable": true
},
"defaultBranch": {
"type": "string"
},
"fetchLfs": {
"type": "boolean"
},
"fetchSubmodules": {
"type": "boolean"
},
"forgeApiToken": {
"type": "string",
"nullable": true
},
"forgeBaseUrl": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"GENERIC_GIT",
"GITHUB",
"FORGEJO",
"BITBUCKET_CLOUD",
"GITLAB"
]
}
},
"required": [
"cloneUrl",
"name"
]
}
Responses
{
"cloneUrl": "string",
"credentialType": "NONE",
"credentialUsername": "string",
"defaultBranch": "string",
"fetchLfs": true,
"fetchSubmodules": true,
"forgeBaseUrl": "string",
"forgeConnectionId": "23f8bab4-f6ff-4220-93c8-6aec129e155f",
"hasWebhookSecret": true,
"id": "2695d89e-a42b-4eff-a029-e86b248d3e08",
"name": "string",
"projectId": "13a56153-b659-458c-b14a-86cfbef02a0d",
"remoteFullName": "string",
"type": "GENERIC_GIT",
"webhookUrl": "string",
"webhookUrlPath": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"cloneUrl": {
"type": "string"
},
"credentialType": {
"type": "string",
"enum": [
"NONE",
"USERNAME_PASSWORD",
"SSH_KEY"
]
},
"credentialUsername": {
"type": "string",
"nullable": true
},
"defaultBranch": {
"type": "string"
},
"fetchLfs": {
"type": "boolean"
},
"fetchSubmodules": {
"type": "boolean"
},
"forgeBaseUrl": {
"type": "string",
"nullable": true
},
"forgeConnectionId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"hasWebhookSecret": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"remoteFullName": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"GENERIC_GIT",
"GITHUB",
"FORGEJO",
"BITBUCKET_CLOUD",
"GITLAB"
]
},
"webhookUrl": {
"type": "string"
},
"webhookUrlPath": {
"type": "string"
}
}
}
POST /api/v1/repositories/adopt¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"connectionId": "feb67956-95d0-4a69-bcbc-ca4dc19143a2",
"fullName": "string",
"projectId": "97b4ecab-2143-45bf-b2d5-af5ae0490a91"
}
Schema of the request body
{
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"format": "uuid"
},
"fullName": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"required": [
"fullName"
]
}
Responses
{
"cloneUrl": "string",
"credentialType": "NONE",
"credentialUsername": "string",
"defaultBranch": "string",
"fetchLfs": true,
"fetchSubmodules": true,
"forgeBaseUrl": "string",
"forgeConnectionId": "bf870b47-82b9-4e51-918a-2e29bbf3146a",
"hasWebhookSecret": true,
"id": "b61ef102-63ec-4573-bf74-402eee80b772",
"name": "string",
"projectId": "0d006794-74d6-493d-8ea4-a6ef65f78557",
"remoteFullName": "string",
"type": "GENERIC_GIT",
"webhookUrl": "string",
"webhookUrlPath": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"cloneUrl": {
"type": "string"
},
"credentialType": {
"type": "string",
"enum": [
"NONE",
"USERNAME_PASSWORD",
"SSH_KEY"
]
},
"credentialUsername": {
"type": "string",
"nullable": true
},
"defaultBranch": {
"type": "string"
},
"fetchLfs": {
"type": "boolean"
},
"fetchSubmodules": {
"type": "boolean"
},
"forgeBaseUrl": {
"type": "string",
"nullable": true
},
"forgeConnectionId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"hasWebhookSecret": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"remoteFullName": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"GENERIC_GIT",
"GITHUB",
"FORGEJO",
"BITBUCKET_CLOUD",
"GITLAB"
]
},
"webhookUrl": {
"type": "string"
},
"webhookUrlPath": {
"type": "string"
}
}
}
GET /api/v1/repositories/browse¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
connectionId |
query | string | No | ||
page |
query | integer | 0 | No | |
search |
query | string | No | ||
size |
query | integer | 100 | No |
Responses
{
"hasMore": true,
"page": 16,
"repositories": [
{
"adoptedAs": "3ca10fec-01a4-4f60-9791-ea324460e13c",
"cloneUrl": "string",
"defaultBranch": "string",
"description": "string",
"fullName": "string",
"name": "string",
"owner": "string",
"private": true
}
],
"size": 193,
"totalRepositories": 286
}
Schema of the response body
{
"type": "object",
"properties": {
"hasMore": {
"type": "boolean"
},
"page": {
"type": "integer",
"format": "int32"
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RemoteRepositoryResponse"
}
},
"size": {
"type": "integer",
"format": "int32"
},
"totalRepositories": {
"type": "integer",
"format": "int32"
}
}
}
DELETE /api/v1/repositories/{repositoryId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
repositoryId |
path | string | No |
Responses
GET /api/v1/repositories/{repositoryId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
repositoryId |
path | string | No |
Responses
{
"cloneUrl": "string",
"credentialType": "NONE",
"credentialUsername": "string",
"defaultBranch": "string",
"fetchLfs": true,
"fetchSubmodules": true,
"forgeBaseUrl": "string",
"forgeConnectionId": "e36a01db-b7b6-4530-a5dc-302a4926a0fb",
"hasWebhookSecret": true,
"id": "cfadfcf5-d905-485e-a715-34d3218a73ef",
"name": "string",
"projectId": "5a3634bf-b163-41a0-9671-049d8f719fd8",
"remoteFullName": "string",
"type": "GENERIC_GIT",
"webhookUrl": "string",
"webhookUrlPath": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"cloneUrl": {
"type": "string"
},
"credentialType": {
"type": "string",
"enum": [
"NONE",
"USERNAME_PASSWORD",
"SSH_KEY"
]
},
"credentialUsername": {
"type": "string",
"nullable": true
},
"defaultBranch": {
"type": "string"
},
"fetchLfs": {
"type": "boolean"
},
"fetchSubmodules": {
"type": "boolean"
},
"forgeBaseUrl": {
"type": "string",
"nullable": true
},
"forgeConnectionId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"hasWebhookSecret": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"remoteFullName": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"GENERIC_GIT",
"GITHUB",
"FORGEJO",
"BITBUCKET_CLOUD",
"GITLAB"
]
},
"webhookUrl": {
"type": "string"
},
"webhookUrlPath": {
"type": "string"
}
}
}
PATCH /api/v1/repositories/{repositoryId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
repositoryId |
path | string | No |
Request body
{
"cloneUrl": "string",
"credentialSecret": "string",
"credentialType": "NONE",
"credentialUsername": "string",
"defaultBranch": "string",
"fetchLfs": true,
"fetchSubmodules": true,
"forgeApiToken": "string",
"forgeBaseUrl": "string",
"name": "string",
"type": "GENERIC_GIT"
}
Schema of the request body
{
"type": "object",
"properties": {
"cloneUrl": {
"type": "string",
"nullable": true
},
"credentialSecret": {
"type": "string",
"nullable": true
},
"credentialType": {
"type": "string",
"enum": [
"NONE",
"USERNAME_PASSWORD",
"SSH_KEY"
],
"nullable": true
},
"credentialUsername": {
"type": "string",
"nullable": true
},
"defaultBranch": {
"type": "string",
"nullable": true
},
"fetchLfs": {
"type": "boolean",
"nullable": true
},
"fetchSubmodules": {
"type": "boolean",
"nullable": true
},
"forgeApiToken": {
"type": "string",
"nullable": true
},
"forgeBaseUrl": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"GENERIC_GIT",
"GITHUB",
"FORGEJO",
"BITBUCKET_CLOUD",
"GITLAB"
],
"nullable": true
}
}
}
Responses
{
"cloneUrl": "string",
"credentialType": "NONE",
"credentialUsername": "string",
"defaultBranch": "string",
"fetchLfs": true,
"fetchSubmodules": true,
"forgeBaseUrl": "string",
"forgeConnectionId": "3387fa2c-ae21-4e2f-afcc-99323dab6ab0",
"hasWebhookSecret": true,
"id": "34124928-bb0b-4d13-8cb5-3901b5f228ab",
"name": "string",
"projectId": "2d3accc2-05d5-48b9-9a7e-775cb0cd3bc4",
"remoteFullName": "string",
"type": "GENERIC_GIT",
"webhookUrl": "string",
"webhookUrlPath": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"cloneUrl": {
"type": "string"
},
"credentialType": {
"type": "string",
"enum": [
"NONE",
"USERNAME_PASSWORD",
"SSH_KEY"
]
},
"credentialUsername": {
"type": "string",
"nullable": true
},
"defaultBranch": {
"type": "string"
},
"fetchLfs": {
"type": "boolean"
},
"fetchSubmodules": {
"type": "boolean"
},
"forgeBaseUrl": {
"type": "string",
"nullable": true
},
"forgeConnectionId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"hasWebhookSecret": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"remoteFullName": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"GENERIC_GIT",
"GITHUB",
"FORGEJO",
"BITBUCKET_CLOUD",
"GITLAB"
]
},
"webhookUrl": {
"type": "string"
},
"webhookUrlPath": {
"type": "string"
}
}
}
POST /api/v1/repositories/{repositoryId}/link¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
repositoryId |
path | string | No |
Request body
{
"connectionId": "93e89f2e-bbf5-45ba-950b-7a2e8a2b153c",
"fullName": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"format": "uuid"
},
"fullName": {
"type": "string",
"minLength": 1
}
},
"required": [
"fullName"
]
}
Responses
{
"cloneUrl": "string",
"credentialType": "NONE",
"credentialUsername": "string",
"defaultBranch": "string",
"fetchLfs": true,
"fetchSubmodules": true,
"forgeBaseUrl": "string",
"forgeConnectionId": "29e1ce4e-26b1-48f9-9442-9a5b04cd093d",
"hasWebhookSecret": true,
"id": "457f6811-4ee9-4a95-8b62-7254e179f92a",
"name": "string",
"projectId": "245720d4-6245-4157-b9b9-f026ccfecaf0",
"remoteFullName": "string",
"type": "GENERIC_GIT",
"webhookUrl": "string",
"webhookUrlPath": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"cloneUrl": {
"type": "string"
},
"credentialType": {
"type": "string",
"enum": [
"NONE",
"USERNAME_PASSWORD",
"SSH_KEY"
]
},
"credentialUsername": {
"type": "string",
"nullable": true
},
"defaultBranch": {
"type": "string"
},
"fetchLfs": {
"type": "boolean"
},
"fetchSubmodules": {
"type": "boolean"
},
"forgeBaseUrl": {
"type": "string",
"nullable": true
},
"forgeConnectionId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"hasWebhookSecret": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"remoteFullName": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"GENERIC_GIT",
"GITHUB",
"FORGEJO",
"BITBUCKET_CLOUD",
"GITLAB"
]
},
"webhookUrl": {
"type": "string"
},
"webhookUrlPath": {
"type": "string"
}
}
}
POST /api/v1/repositories/{repositoryId}/webhook-secret¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
repositoryId |
path | string | No |
Responses
Schema of the response body
{
"type": "object",
"additionalProperties": {
"type": "string"
}
}
Tokens¶
GET /api/v1/tokens¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Responses
[
{
"createdAt": "2022-04-13T15:42:05.901Z",
"expiresAt": "2022-04-13T15:42:05.901Z",
"id": "436a4aed-9609-459b-8b59-3b51c3861017",
"lastUsedAt": "2022-04-13T15:42:05.901Z",
"name": "string",
"prefix": "string",
"token": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiTokenResponse"
}
}
POST /api/v1/tokens¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"expiresInDays": 62,
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"expiresInDays": {
"type": "integer",
"format": "int64",
"nullable": true
},
"name": {
"type": "string"
}
}
}
Responses
{
"createdAt": "2022-04-13T15:42:05.901Z",
"expiresAt": "2022-04-13T15:42:05.901Z",
"id": "67636c63-660d-422c-b00a-a838366e4595",
"lastUsedAt": "2022-04-13T15:42:05.901Z",
"name": "string",
"prefix": "string",
"token": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"lastUsedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string"
},
"prefix": {
"type": "string"
},
"token": {
"type": "string",
"nullable": true
}
}
}
DELETE /api/v1/tokens/{tokenId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
tokenId |
path | string | No |
Responses
Variables¶
GET /api/v1/variables¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
scope |
query | string | No | ||
scopeId |
query | string | No |
Responses
[
{
"id": "7b4e887c-6297-456c-939a-c44487b0ddcb",
"name": "string",
"scope": "GLOBAL",
"scopeId": "413e0f26-bd35-46f4-9179-a4d283f5ffba",
"secret": true,
"value": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/VariableResponse"
}
}
PUT /api/v1/variables¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Request body
{
"name": "string",
"scope": "GLOBAL",
"scopeId": "defa8db6-8db0-46ca-b3c7-7b1981abf2fa",
"secret": true,
"value": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"scope": {
"type": "string",
"enum": [
"GLOBAL",
"PROJECT",
"PLAN",
"ENVIRONMENT"
]
},
"scopeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"secret": {
"type": "boolean"
},
"value": {
"type": "string",
"minLength": 1
}
},
"required": [
"name",
"value"
]
}
Responses
{
"id": "d831cfb1-88ce-4903-bf4f-b5efddf0d07b",
"name": "string",
"scope": "GLOBAL",
"scopeId": "62480a1d-9561-44e6-82fb-f8efc2cc3749",
"secret": true,
"value": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"scope": {
"type": "string",
"enum": [
"GLOBAL",
"PROJECT",
"PLAN",
"ENVIRONMENT"
]
},
"scopeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"secret": {
"type": "boolean"
},
"value": {
"type": "string",
"nullable": true
}
}
}
DELETE /api/v1/variables/{variableId}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basicToken |
header | string | N/A | No | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
variableId |
path | string | No |
Responses
Schemas¶
AddPlanRepositoryRequest¶
| Name | Type | Description |
|---|---|---|
branch |
string | null | |
checkoutDirectory |
string | null | |
repositoryId |
string(uuid) |
AdoptRepositoryRequest¶
| Name | Type | Description |
|---|---|---|
connectionId |
string(uuid) | |
fullName |
string | |
projectId |
string(uuid) | null |
AgentActivityResponse¶
| Name | Type | Description |
|---|---|---|
agentId |
string(uuid) | |
capabilities |
||
maxConcurrentJobs |
integer(int32) | |
name |
string | |
runningJobs |
integer(int32) |
AgentResponse¶
| Name | Type | Description |
|---|---|---|
activeJobs |
integer(int32) | |
capabilities |
||
connected |
boolean | |
diskFloorBytes |
integer(int64) | null | |
diskFreeBytes |
integer(int64) | null | |
diskTotalBytes |
integer(int64) | null | |
enabled |
boolean | |
ephemeral |
boolean | |
executors |
Array<string> | |
id |
string(uuid) | |
lastSeenAt |
string(date-time) | null | |
name |
string | |
version |
string | null | |
workspacesLeftBehind |
integer(int32) | |
workspacesLeftBehindBytes |
integer(int64) |
ApiTokenResponse¶
| Name | Type | Description |
|---|---|---|
createdAt |
string(date-time) | |
expiresAt |
string(date-time) | null | |
id |
string(uuid) | |
lastUsedAt |
string(date-time) | null | |
name |
string | |
prefix |
string | |
token |
string | null |
ArtifactResponse¶
| Name | Type | Description |
|---|---|---|
contentType |
string | |
createdAt |
string(date-time) | |
id |
string(uuid) | |
name |
string | |
path |
string | |
sha256 |
string | null | |
sizeBytes |
integer(int64) |
AuditActorResponse¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
name |
string | null |
AuditEventResponse¶
| Name | Type | Description |
|---|---|---|
action |
string | |
actorId |
string(uuid) | null | |
actorName |
string | null | |
actorType |
string | |
detail |
string | null | |
id |
string(uuid) | |
occurredAt |
string(date-time) | |
outcome |
string | |
targetId |
string(uuid) | null | |
targetName |
string | null | |
targetType |
string | null |
AuditPageResponse¶
| Name | Type | Description |
|---|---|---|
events |
Array<AuditEventResponse> | |
hasMore |
boolean | |
page |
integer(int32) | |
size |
integer(int32) | |
totalEvents |
integer(int64) |
BranchCleanupSettings¶
| Name | Type | Description |
|---|---|---|
deletedDays |
integer(int32) | null | |
inactiveDays |
integer(int32) | null |
BuildResponse¶
| Name | Type | Description |
|---|---|---|
branch |
string | null | |
buildNumber |
integer(int32) | |
commitSha |
string | null | |
environmentId |
string(uuid) | null | |
errorMessage |
string | null | |
finishedAt |
string(date-time) | null | |
id |
string(uuid) | |
planId |
string(uuid) | |
queuedAt |
string(date-time) | |
releaseId |
string(uuid) | null | |
rerunCount |
integer(int32) | |
rerunOf |
||
resultTransition |
string | null | |
stages |
Array<StageResponse> | |
startedAt |
string(date-time) | null | |
status |
string | |
triggerDetail |
string | null | |
triggerType |
string |
CarriedFromResponse¶
| Name | Type | Description |
|---|---|---|
buildNumber |
integer(int32) | |
buildRunId |
string(uuid) | |
jobRunId |
string(uuid) |
ClaimAddressRequest¶
| Name | Type | Description |
|---|---|---|
address |
string |
CommitAddressResponse¶
| Name | Type | Description |
|---|---|---|
address |
string | |
id |
string(uuid) |
ConcurrencySettings¶
| Name | Type | Description |
|---|---|---|
limit |
integer(int32) | null | |
strategy |
string |
ConsumedArtifactResponse¶
| Name | Type | Description |
|---|---|---|
fromJob |
string | |
into |
string | |
name |
string |
CreateApiTokenRequest¶
| Name | Type | Description |
|---|---|---|
expiresInDays |
integer(int64) | null | |
name |
string |
CreateDeploymentProjectRequest¶
| Name | Type | Description |
|---|---|---|
description |
string | null | |
key |
string | |
name |
string |
CreateEnvironmentRequest¶
| Name | Type | Description |
|---|---|---|
deployOnRelease |
boolean | |
key |
string | |
name |
string | |
position |
integer(int32) | |
promoteAfterEnvironmentId |
string(uuid) | null | |
specPath |
string | null | |
specSource |
string | |
specYaml |
string | null |
CreateForgeConnectionRequest¶
| Name | Type | Description |
|---|---|---|
apiToken |
string | |
baseUrl |
string | |
name |
string | |
type |
string |
CreateGroupRequest¶
| Name | Type | Description |
|---|---|---|
description |
string | null | |
name |
string |
CreateNotificationRequest¶
| Name | Type | Description |
|---|---|---|
channel |
string | |
event |
string | |
target |
string |
CreatePlanRequest¶
| Name | Type | Description |
|---|---|---|
branchDivergence |
boolean | |
description |
string | null | |
key |
string | |
name |
string | |
projectId |
string(uuid) | |
repositoryId |
string(uuid) | null | |
specPath |
string | null | |
specSource |
string | |
specYaml |
string | null |
CreateProjectRequest¶
| Name | Type | Description |
|---|---|---|
description |
string | null | |
key |
string | |
name |
string |
CreateReleaseRequest¶
| Name | Type | Description |
|---|---|---|
buildRunId |
string(uuid) | |
name |
string | null |
CreateRepositoryRequest¶
| Name | Type | Description |
|---|---|---|
cloneUrl |
string | |
credentialSecret |
string | null | |
credentialType |
string | |
credentialUsername |
string | null | |
defaultBranch |
string | |
fetchLfs |
boolean | |
fetchSubmodules |
boolean | |
forgeApiToken |
string | null | |
forgeBaseUrl |
string | null | |
name |
string | |
projectId |
string(uuid) | null | |
type |
string |
CreateTriggerRequest¶
| Name | Type | Description |
|---|---|---|
branch |
string | null | |
branches |
Array<string> | |
conditions |
Array<TriggerConditionPayload> | |
cron |
string | null | |
type |
string | |
upstreamPlanId |
string(uuid) | null |
CreateUserRequest¶
| Name | Type | Description |
|---|---|---|
displayName |
string | null | |
email |
string | null | |
globalRole |
string | |
password |
string | |
username |
string |
DeploymentProjectResponse¶
| Name | Type | Description |
|---|---|---|
autoReleaseBranch |
string | null | |
createdAt |
string(date-time) | |
description |
string | null | |
id |
string(uuid) | |
key |
string | |
name |
string | |
nextVersion |
string | null | |
planId |
string(uuid) | |
versionScheme |
string |
DeployRequest¶
| Name | Type | Description |
|---|---|---|
releaseId |
string(uuid) |
EnrolmentTokenRequest¶
| Name | Type | Description |
|---|---|---|
uses |
integer(int32) |
EnvironmentResponse¶
| Name | Type | Description |
|---|---|---|
deploymentProjectId |
string(uuid) | |
deployOnRelease |
boolean | |
id |
string(uuid) | |
key |
string | |
name |
string | |
nextDeploymentNumber |
integer(int32) | |
position |
integer(int32) | |
promoteAfterEnvironmentId |
string(uuid) | null | |
specPath |
string | null | |
specSource |
string | |
specYaml |
string | null |
FailedTestResponse¶
| Name | Type | Description |
|---|---|---|
detail |
string | null | |
durationMillis |
integer(int64) | |
failingSince |
integer(int32) | null | |
history |
string | |
id |
string(uuid) | |
message |
string | null | |
name |
string | |
outcome |
string | |
suite |
string | |
testId |
string(uuid) | null |
FixedTestResponse¶
| Name | Type | Description |
|---|---|---|
name |
string | |
suite |
string |
ForgeConnectionResponse¶
| Name | Type | Description |
|---|---|---|
baseUrl |
string | |
createdAt |
string(date-time) | |
id |
string(uuid) | |
name |
string | |
type |
string | |
updatedAt |
string(date-time) | |
username |
string |
ForgeIdentityResponse¶
| Name | Type | Description |
|---|---|---|
fullName |
string | null | |
login |
string |
GrantRequest¶
| Name | Type | Description |
|---|---|---|
permission |
string | |
subjectId |
string(uuid) | null | |
subjectType |
string |
GrantResponse¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
permission |
string | |
subjectId |
string(uuid) | null | |
subjectName |
string | |
subjectType |
string |
GroupResponse¶
| Name | Type | Description |
|---|---|---|
description |
string | null | |
id |
string(uuid) | |
memberCount |
integer(int32) | |
name |
string |
IssuedFeedResponse¶
| Name | Type | Description |
|---|---|---|
url |
string |
IssuedTokenResponse¶
| Name | Type | Description |
|---|---|---|
expiresInMinutes |
integer(int64) | |
token |
string | |
uses |
integer(int32) |
JobResourceSeriesResponse¶
| Name | Type | Description |
|---|---|---|
cpuLimitCores |
number(double) | null | |
diskTotalBytes |
integer(int64) | null | |
jobRunId |
string(uuid) | |
memoryLimitBytes |
integer(int64) | null | |
samples |
Array<ResourceSampleResponse> |
JobResourcesResponse¶
| Name | Type | Description |
|---|---|---|
cpuCoresUsed |
number(double) | null | |
cpuLimitCores |
number(double) | null | |
cpuSeconds |
number(double) | null | |
diskReadBytes |
integer(int64) | null | |
diskTotalBytes |
integer(int64) | null | |
diskUtilisation |
number(double) | null | |
diskWriteBytes |
integer(int64) | null | |
memoryLimitBytes |
integer(int64) | null | |
memoryReservation |
string | null | |
memoryUtilisation |
number(double) | null | |
networkRxBytes |
integer(int64) | null | |
networkTxBytes |
integer(int64) | null | |
oomKilled |
boolean | |
peakDiskUsedBytes |
integer(int64) | null | |
peakMemoryBytes |
integer(int64) | null | |
requestedCpuMillicores |
integer(int32) | null | |
requestedMemoryBytes |
integer(int64) | null | |
requestedMemoryDefaulted |
boolean | |
summary |
string |
JobResponse¶
| Name | Type | Description |
|---|---|---|
agentId |
string(uuid) | null | |
agentName |
string | null | |
carriedFrom |
||
consumes |
Array<ConsumedArtifactResponse> | |
errorMessage |
string | null | |
failedTests |
Array<FailedTestResponse> | |
finishedAt |
string(date-time) | null | |
fixedTests |
Array<FixedTestResponse> | |
id |
string(uuid) | |
key |
string | |
name |
string | |
quarantinedTests |
Array<FailedTestResponse> | |
rerunCount |
integer(int32) | |
resources |
||
resultsIn |
string(uuid) | |
runtimeImage |
string | null | |
runtimeType |
string | |
services |
Array<JobServiceResponse> | |
startedAt |
string(date-time) | null | |
status |
string | |
steps |
Array<StepResponse> | |
tests |
JobServiceResponse¶
| Name | Type | Description |
|---|---|---|
image |
string | |
name |
string |
LinkRepositoryRequest¶
| Name | Type | Description |
|---|---|---|
connectionId |
string(uuid) | |
fullName |
string |
NotificationPreferencesResponse¶
| Name | Type | Description |
|---|---|---|
addresses |
Array<CommitAddressResponse> | |
feedIssuedAt |
string(date-time) | null | |
mutedPlanIds |
Array<string(uuid)> | |
wanted |
NotificationResponse¶
| Name | Type | Description |
|---|---|---|
channel |
string | |
enabled |
boolean | |
event |
string | |
id |
string(uuid) | |
target |
string |
PlanBranchResponse¶
| Name | Type | Description |
|---|---|---|
firstSeenAt |
string(date-time) | |
lastBuiltAt |
string(date-time) | null | |
latestBuild |
||
live |
boolean | |
name |
string |
PlanRepositoryResponse¶
| Name | Type | Description |
|---|---|---|
branch |
string | null | |
checkoutDirectory |
string | |
id |
string(uuid) | |
position |
integer(int32) | |
repositoryId |
string(uuid) |
PlanResponse¶
| Name | Type | Description |
|---|---|---|
branchCleanup |
BranchCleanupSettings | |
branchDivergence |
boolean | |
concurrency |
ConcurrencySettings | |
description |
string | null | |
enabled |
boolean | |
id |
string(uuid) | |
key |
string | |
labels |
Array<string> | |
name |
string | |
nextBuildNumber |
integer(int32) | |
projectId |
string(uuid) | |
repositories |
Array<PlanRepositoryResponse> | |
repositoryId |
string(uuid) | null | |
retention |
RetentionSettings | |
specPath |
string | |
specSource |
string | |
specYaml |
string | null |
ProjectResponse¶
| Name | Type | Description |
|---|---|---|
createdAt |
string(date-time) | |
description |
string | null | |
id |
string(uuid) | |
key |
string | |
name |
string |
PutVariableRequest¶
| Name | Type | Description |
|---|---|---|
name |
string | |
scope |
string | |
scopeId |
string(uuid) | null | |
secret |
boolean | |
value |
string |
QuarantinedTestResponse¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
name |
string | |
reason |
string | null | |
since |
string(date-time) | |
suite |
string |
QuarantineTestRequest¶
| Name | Type | Description |
|---|---|---|
name |
string | |
reason |
string | null | |
suite |
string |
QueuedJob¶
| Name | Type | Description |
|---|---|---|
agentName |
string | null | |
branch |
string | null | |
buildNumber |
integer(int32) | |
buildRunId |
string(uuid) | |
environmentName |
string | null | |
jobKey |
string | |
jobName |
string | |
jobRunId |
string(uuid) | |
planKey |
string | |
reason |
string | |
requirements |
||
resources |
Resources | |
runtimeType |
string | |
since |
string(date-time) | null | |
status |
string | |
waitingSeconds |
integer(int64) | null |
ReleaseCommitsResponse¶
| Name | Type | Description |
|---|---|---|
commits |
Array<ReleasedCommitResponse> | |
detail |
string | null | |
reason |
string | null | |
releaseId |
string(uuid) | |
since |
||
total |
integer(int32) | null | |
wasCut |
boolean |
ReleasedCommitResponse¶
| Name | Type | Description |
|---|---|---|
author |
string | null | |
committedAt |
string(date-time) | null | |
sha |
string | |
subject |
string | |
url |
string | null |
ReleaseResponse¶
| Name | Type | Description |
|---|---|---|
buildRunId |
string(uuid) | |
createdAt |
string(date-time) | |
deploymentProjectId |
string(uuid) | |
id |
string(uuid) | |
name |
string |
RemoteRepositoryPageResponse¶
| Name | Type | Description |
|---|---|---|
hasMore |
boolean | |
page |
integer(int32) | |
repositories |
Array<RemoteRepositoryResponse> | |
size |
integer(int32) | |
totalRepositories |
integer(int32) |
RemoteRepositoryResponse¶
| Name | Type | Description |
|---|---|---|
adoptedAs |
string(uuid) | null | |
cloneUrl |
string | |
defaultBranch |
string | |
description |
string | null | |
fullName |
string | |
name |
string | |
owner |
string | |
private |
boolean |
RepositoryResponse¶
| Name | Type | Description |
|---|---|---|
cloneUrl |
string | |
credentialType |
string | |
credentialUsername |
string | null | |
defaultBranch |
string | |
fetchLfs |
boolean | |
fetchSubmodules |
boolean | |
forgeBaseUrl |
string | null | |
forgeConnectionId |
string(uuid) | null | |
hasWebhookSecret |
boolean | |
id |
string(uuid) | |
name |
string | |
projectId |
string(uuid) | null | |
remoteFullName |
string | null | |
type |
string | |
webhookUrl |
string | |
webhookUrlPath |
string |
RerunBuildRequest¶
| Name | Type | Description |
|---|---|---|
scope |
string |
RerunSourceResponse¶
| Name | Type | Description |
|---|---|---|
buildNumber |
integer(int32) | |
id |
string(uuid) |
Resources¶
| Name | Type | Description |
|---|---|---|
cpuCores |
number(double) | null | |
cpuMillicores |
integer(int32) | null | |
declared |
boolean | |
description |
string | |
memoryBytes |
integer(int64) | null |
ResourceSampleResponse¶
| Name | Type | Description |
|---|---|---|
at |
string(date-time) | |
cpuCores |
number(double) | null | |
diskReadBytesPerSecond |
number(double) | null | |
diskUsedBytes |
integer(int64) | null | |
diskWriteBytesPerSecond |
number(double) | null | |
memoryBytes |
integer(int64) | null | |
networkRxBytesPerSecond |
number(double) | null | |
networkTxBytesPerSecond |
number(double) | null |
RetentionSettings¶
| Name | Type | Description |
|---|---|---|
builds |
integer(int32) | null | |
days |
integer(int32) | null |
ScheduledJobResponse¶
| Name | Type | Description |
|---|---|---|
description |
string | |
key |
string | |
lastDurationSeconds |
integer(int64) | null | |
lastRunAt |
string(date-time) | null | |
nextDueAt |
string(date-time) | null | |
periodSeconds |
integer(int64) | |
ranOn |
string | null | |
runnable |
boolean | |
running |
boolean | |
title |
string |
SetPreferencesRequest¶
| Name | Type | Description |
|---|---|---|
wanted |
SignedProvenance¶
| Name | Type | Description |
|---|---|---|
algorithm |
string | |
payload |
string | |
publicKey |
string | |
signature |
string |
StageResponse¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
jobs |
Array<JobResponse> | |
manual |
boolean | |
name |
string | |
position |
integer(int32) | |
status |
string |
StepResponse¶
| Name | Type | Description |
|---|---|---|
exitCode |
integer(int32) | null | |
finishedAt |
string(date-time) | null | |
index |
integer(int32) | |
kind |
string | |
name |
string | |
startedAt |
string(date-time) | null | |
status |
string |
TestSummaryResponse¶
| Name | Type | Description |
|---|---|---|
failed |
integer(int64) | |
passed |
integer(int64) | |
skipped |
integer(int64) | |
total |
integer(int64) |
TriggerBuildRequest¶
| Name | Type | Description |
|---|---|---|
branch |
string | null | |
commitSha |
string | null |
TriggerConditionPayload¶
| Name | Type | Description |
|---|---|---|
exclude |
Array<string> | |
include |
Array<string> | |
type |
string |
TriggerResponse¶
| Name | Type | Description |
|---|---|---|
branch |
string | null | |
branches |
Array<string> | |
conditions |
Array<TriggerConditionPayload> | |
cron |
string | null | |
enabled |
boolean | |
id |
string(uuid) | |
lastFiredAt |
string(date-time) | null | |
nextFireAt |
string(date-time) | null | |
source |
string | |
type |
string | |
upstreamPlanId |
string(uuid) | null |
UpdateDeploymentProjectRequest¶
| Name | Type | Description |
|---|---|---|
autoReleaseBranch |
string | null | |
clearAutoRelease |
boolean | |
clearDescription |
boolean | |
description |
string | null | |
name |
string | null | |
nextVersion |
string | null | |
versionScheme |
string | null |
UpdateEnvironmentRequest¶
| Name | Type | Description |
|---|---|---|
clearPromotion |
boolean | |
deployOnRelease |
boolean | null | |
name |
string | null | |
position |
integer(int32) | null | |
promoteAfterEnvironmentId |
string(uuid) | null | |
specPath |
string | null | |
specSource |
string | null | |
specYaml |
string | null |
UpdateForgeConnectionRequest¶
| Name | Type | Description |
|---|---|---|
apiToken |
string | null | |
baseUrl |
string | null | |
name |
string | null |
UpdateGroupRequest¶
| Name | Type | Description |
|---|---|---|
description |
string | null | |
name |
string | null |
UpdatePlanRequest¶
| Name | Type | Description |
|---|---|---|
branchCleanup |
||
branchDivergence |
boolean | null | |
concurrency |
||
description |
string | null | |
enabled |
boolean | null | |
labels |
Array<string> | |
name |
string | null | |
repositoryId |
string(uuid) | null | |
retention |
||
specPath |
string | null | |
specSource |
string | null | |
specYaml |
string | null |
UpdateProjectRequest¶
| Name | Type | Description |
|---|---|---|
description |
string | null | |
key |
string | null | |
name |
string | null |
UpdateRepositoryRequest¶
| Name | Type | Description |
|---|---|---|
cloneUrl |
string | null | |
credentialSecret |
string | null | |
credentialType |
string | null | |
credentialUsername |
string | null | |
defaultBranch |
string | null | |
fetchLfs |
boolean | null | |
fetchSubmodules |
boolean | null | |
forgeApiToken |
string | null | |
forgeBaseUrl |
string | null | |
name |
string | null | |
type |
string | null |
UpdateTriggerRequest¶
| Name | Type | Description |
|---|---|---|
branches |
Array<string> | |
conditions |
Array<TriggerConditionPayload> |
UpdateUserRequest¶
| Name | Type | Description |
|---|---|---|
displayName |
string | null | |
email |
string | null | |
enabled |
boolean | null | |
globalRole |
string | null | |
password |
string | null |
UserNotificationResponse¶
| Name | Type | Description |
|---|---|---|
buildRunId |
string(uuid) | null | |
commitSha |
string | null | |
createdAt |
string(date-time) | |
id |
string(uuid) | |
kind |
string | |
planId |
string(uuid) | |
releaseId |
string(uuid) | null | |
summary |
string | |
title |
string |
UserResponse¶
| Name | Type | Description |
|---|---|---|
authSource |
string | |
displayName |
string | null | |
email |
string | null | |
enabled |
boolean | |
globalRole |
string | |
id |
string(uuid) | |
username |
string |
VariableResponse¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
name |
string | |
scope |
string | |
scopeId |
string(uuid) | null | |
secret |
boolean | |
value |
string | null |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicToken | http | basic | The username, and a personal access token as issued by `POST /api/v1/tokens` in place of a password. |
Tags¶
| Name | Description |
|---|---|
| Agents | The agents jobs run on: what the fleet is doing, and the tokens that enrol more of it. |
| Audit | Who changed what, and when, for as long as the retention window has kept it. |
| Builds | Runs and their jobs: what happened, what it printed, what it held, and what it produced. |
| Deployments | Deployment projects, their environments, and shipping releases to them. |
| Forges | The credentials repositories are read through, one per forge. |
| My notifications | The caller's own feed, and the plans they have muted. |
| Permissions | Who may do what, on one project, plan, deployment project or environment. |
| Plan notifications | Who a plan tells when its runs finish. |
| Plan triggers | What starts a plan without anybody pressing anything. |
| Plans | Plans, the branches they have built, and starting a build of one. |
| Projects | Projects, and the plans inside them. |
| Quarantine | Tests whose failures no longer fail a plan's builds. |
| Queue | Everything in flight, and the agents running it. |
| Repositories | The repositories plans check out, and adopting more of them from a forge. |
| Scheduled jobs | This server's own recurring work, and running one of them now. |
| Tokens | Personal access tokens -- the credential every other endpoint here is called with. |
| Users | Accounts, their roles, and the groups a directory put them in. |
| Variables | The values a build runs with. A secret is one of these that is kept. |