Skip to main content

Server API v1

Server API v1#

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Kraken Server REST API

Authentication#

  • HTTP Authentication, scheme: bearer

Users#

login#

Code samples

# You can also use wget
curl -X POST /api/sessions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

POST /sessions

Create a session ie. log in.

Body parameter

{
"user": "string",
"password": "string"
}

Parameters#

NameInTypeRequiredDescription
bodybodyobjectfalseproject
» userbodystringfalsenone
» passwordbodystringfalsenone

Example responses

201 Response

{
"id": 0,
"token": "string"
}

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created session.Session

logout#

Code samples

# You can also use wget
curl -X DELETE /api/sessions/{session_id} \
-H 'Authorization: Bearer {access-token}'

DELETE /sessions/{session_id}

Logout

Logut

Parameters#

NameInTypeRequiredDescription
session_idpathinteger(int64)trueID of session

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfully deleted sessionNone

Response Schema#

change_password#

Code samples

# You can also use wget
curl -X PUT /api/users/{user_id}/password \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /users/{user_id}/password

Change user password

Change user password

Body parameter

{
"password_old": "string",
"password_new": "string"
}

Parameters#

NameInTypeRequiredDescription
user_idpathinteger(int64)trueID of user
bodybodyUserPasswordtruesecret

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfullyNone

Response Schema#

Management#

get_projects#

Code samples

# You can also use wget
curl -X GET /api/projects \
-H 'Authorization: Bearer {access-token}'

GET /projects

Create a project

Create a new project

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runNone

Response Schema#

create_project#

Code samples

# You can also use wget
curl -X POST /api/projects \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

POST /projects

Create a project

Create a new project

Body parameter

{
"id": 0,
"name": "string",
"webhooks": {},
"branches": [
{}
]
}

Parameters#

NameInTypeRequiredDescription
bodybodyProjectfalseproject

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runNone

Response Schema#

get_project#

Code samples

# You can also use wget
curl -X GET /api/projects/{project_id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /projects/{project_id}

Get project

Get project details

Parameters#

NameInTypeRequiredDescription
project_idpathinteger(int64)trueID of project
with_resultsquerybooleanfalsewith results

Example responses

200 Response

{
"id": 0,
"name": "string",
"webhooks": {},
"branches": [
{}
]
}

Responses#

StatusMeaningDescriptionSchema
200OKProject detailsProject

update_project#

Code samples

# You can also use wget
curl -X PUT /api/projects/{project_id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /projects/{project_id}

Update a project

Update project settings

Body parameter

{
"id": 0,
"name": "string",
"webhooks": {},
"branches": [
{}
]
}

Parameters#

NameInTypeRequiredDescription
project_idpathinteger(int64)trueID of project
bodybodyProjectfalseproject

Example responses

200 Response

{
"id": 0,
"name": "string",
"webhooks": {},
"branches": [
{}
]
}

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfullyProject

delete_project#

Code samples

# You can also use wget
curl -X DELETE /api/projects/{project_id} \
-H 'Authorization: Bearer {access-token}'

DELETE /projects/{project_id}

Delete a project

Delete a project

Parameters#

NameInTypeRequiredDescription
project_idpathinteger(int64)trueID of project

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfully deleted projectNone

Response Schema#

create_secret#

Code samples

# You can also use wget
curl -X POST /api/projects/{project_id}/secrets \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

POST /projects/{project_id}/secrets

Create a secret

Create a new secret

Body parameter

{
"id": 0,
"name": "string",
"project_id": 0,
"project_name": "string",
"kind": "string",
"username": "string",
"key": "string"
}

Parameters#

NameInTypeRequiredDescription
project_idpathinteger(int64)trueID of project
bodybodySecretfalsesecret

Example responses

201 Response

{
"id": 0,
"name": "string",
"project_id": 0,
"project_name": "string",
"kind": "string",
"username": "string",
"key": "string"
}

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runSecret

update_secret#

Code samples

# You can also use wget
curl -X PUT /api/secrets/{secret_id} \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /secrets/{secret_id}

Update a secret

Update secret settings

Body parameter

{
"id": 0,
"name": "string",
"project_id": 0,
"project_name": "string",
"kind": "string",
"username": "string",
"key": "string"
}

Parameters#

NameInTypeRequiredDescription
secret_idpathinteger(int64)trueID of secret
bodybodySecretfalsesecret

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfullyNone

Response Schema#

delete_secret#

Code samples

# You can also use wget
curl -X DELETE /api/secrets/{secret_id} \
-H 'Authorization: Bearer {access-token}'

DELETE /secrets/{secret_id}

Delete a secret

Delete a secret

Parameters#

NameInTypeRequiredDescription
secret_idpathinteger(int64)trueID of secret

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfully deleted secretNone

Response Schema#

create_branch#

Code samples

# You can also use wget
curl -X POST /api/projects/{project_id}/branches \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

POST /projects/{project_id}/branches

Create a branch

Create a new branch

Body parameter

{
"id": 0,
"name": "string",
"branch_name": "string",
"project_id": 0,
"project_name": "string",
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"flows": {}
}

Parameters#

NameInTypeRequiredDescription
project_idpathinteger(int64)trueID of pet to return
bodybodyBranchfalsebranch

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runNone

Response Schema#

update_branch#

Code samples

# You can also use wget
curl -X PUT /api/branches/{branch_id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /branches/{branch_id}

Update a branch

Update branch

Body parameter

{
"id": 0,
"name": "string",
"branch_name": "string",
"project_id": 0,
"project_name": "string",
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"flows": {}
}

Parameters#

NameInTypeRequiredDescription
branch_idpathinteger(int64)trueID of branch
bodybodyBranchfalsebranch

Example responses

200 Response

{
"id": 0,
"name": "string",
"branch_name": "string",
"project_id": 0,
"project_name": "string",
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"flows": {}
}

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfullyBranch

delete_branch#

Code samples

# You can also use wget
curl -X DELETE /api/branches/{branch_id} \
-H 'Authorization: Bearer {access-token}'

DELETE /branches/{branch_id}

Delete a branch

Delete a branch

Parameters#

NameInTypeRequiredDescription
branch_idpathinteger(int64)trueID of branch

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfully deleted branchNone

Response Schema#

get_branch#

Code samples

# You can also use wget
curl -X GET /api/branches/{branch_id}/cfg \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /branches/{branch_id}/cfg

List all results

Parameters#

NameInTypeRequiredDescription
branch_idpathinteger(int64)trueID of pet to return

Example responses

200 Response

{
"id": 0,
"name": "string",
"branch_name": "string",
"project_id": 0,
"project_name": "string",
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"flows": {}
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsBranch
defaultDefaultunexpected errorApiError

get_branch_sequences#

Code samples

# You can also use wget
curl -X GET /api/branches/{branch_id}/sequences \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /branches/{branch_id}/sequences

List branch sequences

Parameters#

NameInTypeRequiredDescription
branch_idpathinteger(int64)trueID of branch

Example responses

200 Response

{
"items": [
{
"id": 0,
"branch_name": "string",
"branch_id": 0,
"stage_name": "string",
"stage_id": 0,
"kind": 0,
"value": 0
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKAn array of branch sequencesBranchSequences
defaultDefaultunexpected errorApiError

create_stage#

Code samples

# You can also use wget
curl -X POST /api/branches/{branch_id}/stages \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

POST /branches/{branch_id}/stages

Create a stage

Create a new stage

Body parameter

{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}

Parameters#

NameInTypeRequiredDescription
branch_idpathinteger(int64)trueID of pet to return
bodybodyStagefalsestage

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runNone

Response Schema#

get_stage#

Code samples

# You can also use wget
curl -X GET /api/stages/{stage_id} \
-H 'Authorization: Bearer {access-token}'

GET /stages/{stage_id}

Get a stage

Get stage settings

Parameters#

NameInTypeRequiredDescription
stage_idpathinteger(int64)trueID of pet to return

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runNone

Response Schema#

update_stage#

Code samples

# You can also use wget
curl -X PUT /api/stages/{stage_id} \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /stages/{stage_id}

Update a stage

Update stage settings

Body parameter

{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}

Parameters#

NameInTypeRequiredDescription
stage_idpathinteger(int64)trueID of pet to return
bodybodyStagetruestage

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runNone

Response Schema#

delete_stage#

Code samples

# You can also use wget
curl -X DELETE /api/stages/{stage_id} \
-H 'Authorization: Bearer {access-token}'

DELETE /stages/{stage_id}

Delete a stage

Delete a stage

Parameters#

NameInTypeRequiredDescription
stage_idpathinteger(int64)trueID of pet to return

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfully deleted stageNone

Response Schema#

get_stage_schema_as_json#

Code samples

# You can also use wget
curl -X PUT /api/stages/{stage_id}/schema \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /stages/{stage_id}/schema

Execute schema_code and return schema in JSON format

Body parameter

{
"schema_code": "string"
}

Parameters#

NameInTypeRequiredDescription
stage_idpathinteger(int64)trueID of pet to return
bodybodyStageSchemaCodefalseSchema code to execute

Example responses

200 Response

{
"stage_id": 0,
"schema": "string",
"error": "string"
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsStageSchemaJson
defaultDefaultunexpected errorApiError

get_stage_schedule#

Code samples

# You can also use wget
curl -X GET /api/stages/{stage_id}/schedule \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /stages/{stage_id}/schedule

Get schedule info for stage if there are time triggers configured.

Parameters#

NameInTypeRequiredDescription
stage_idpathinteger(int64)trueStage ID

Example responses

200 Response

{
"schedules": [
{
"name": "string",
"job_id": "string",
"next_run_time": "string"
}
]
}

Responses#

StatusMeaningDescriptionSchema
200OKAn array of schedulesStageSchedule
defaultDefaultunexpected errorApiError

get_last_celery_task_names#

Code samples

# You can also use wget
curl -X GET /api/last-celery-tasks \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /last-celery-tasks

Get celery logs

Get last celery task names

Example responses

200 Response

{
"items": [
{
"time": "string",
"name": "string",
"lines": 0
}
]
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of logsCeleryTaskNames
defaultDefaultunexpected errorApiError

get_services_logs#

Code samples

# You can also use wget
curl -X GET /api/services-logs \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /services-logs

Get services logs

Get services logs

Parameters#

NameInTypeRequiredDescription
servicesqueryarray[string]falseID of pet to return
levelquerystringfalselog level

Example responses

200 Response

{
"items": [
{
"time": "string",
"message": "string",
"service": "string",
"host": "string",
"level": "string",
"tool": "string"
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of logsServicesLogs
defaultDefaultunexpected errorApiError

get_errors_in_logs_count#

Code samples

# You can also use wget
curl -X GET /api/errors-in-logs \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /errors-in-logs

Get errors in logs count in the last hour

Get errors in logs count in the last hour

Parameters#

NameInTypeRequiredDescription
servicesqueryarray[string]falseID of pet to return

Example responses

200 Response

{
"errors_count": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of logsErrorsInLogsCount
defaultDefaultunexpected errorApiError

get_agents#

Code samples

# You can also use wget
curl -X GET /api/agents \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /agents

Get agents

Get agents

Parameters#

NameInTypeRequiredDescription
unauthorizedquerybooleanfalseID of pet to return
startqueryinteger(int32)falseHow many items to return at one time (max 100)
limitqueryinteger(int32)falseHow many items to return at one time (max 100)

Example responses

200 Response

{
"items": [
{
"id": 0,
"name": "string",
"address": "string",
"authorized": true,
"ip_address": "string",
"state": 0,
"disabled": true,
"groups": [
{}
],
"job": {},
"last_seen": "2019-08-24T14:15:22Z",
"host_info": {},
"user_attrs": {}
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of logsAgents
defaultDefaultunexpected errorApiError

update_agents#

Code samples

# You can also use wget
curl -X PATCH /api/agents \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

PATCH /agents

Update agents

Update agents

Body parameter

[
{
"id": 0,
"name": "string",
"address": "string",
"authorized": true,
"ip_address": "string",
"state": 0,
"disabled": true,
"groups": [
{}
],
"job": {},
"last_seen": "2019-08-24T14:15:22Z",
"host_info": {},
"user_attrs": {}
}
]

Parameters#

NameInTypeRequiredDescription
bodybodyAgentfalseList of modified agents

Example responses

200 Response

{
"items": [
{
"id": 0,
"name": "string",
"address": "string",
"authorized": true,
"ip_address": "string",
"state": 0,
"disabled": true,
"groups": [
{}
],
"job": {},
"last_seen": "2019-08-24T14:15:22Z",
"host_info": {},
"user_attrs": {}
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of logsAgents
defaultDefaultunexpected errorApiError

get_agent#

Code samples

# You can also use wget
curl -X GET /api/agents/{agent_id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /agents/{agent_id}

Get agent

Get agent details

Parameters#

NameInTypeRequiredDescription
agent_idpathinteger(int64)trueID of agent

Example responses

200 Response

{
"id": 0,
"name": "string",
"address": "string",
"authorized": true,
"ip_address": "string",
"state": 0,
"disabled": true,
"groups": [
{}
],
"job": {},
"last_seen": "2019-08-24T14:15:22Z",
"host_info": {},
"user_attrs": {}
}

Responses#

StatusMeaningDescriptionSchema
200OKAgent detailsAgent

update_agent#

Code samples

# You can also use wget
curl -X PUT /api/agents/{agent_id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /agents/{agent_id}

Update a agent

Update agent settings

Body parameter

{
"id": 0,
"name": "string",
"address": "string",
"authorized": true,
"ip_address": "string",
"state": 0,
"disabled": true,
"groups": [
{}
],
"job": {},
"last_seen": "2019-08-24T14:15:22Z",
"host_info": {},
"user_attrs": {}
}

Parameters#

NameInTypeRequiredDescription
agent_idpathinteger(int64)trueID of agent
bodybodyAgentfalseagent

Example responses

200 Response

{
"id": 0,
"name": "string",
"address": "string",
"authorized": true,
"ip_address": "string",
"state": 0,
"disabled": true,
"groups": [
{}
],
"job": {},
"last_seen": "2019-08-24T14:15:22Z",
"host_info": {},
"user_attrs": {}
}

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfullyAgent

delete_agent#

Code samples

# You can also use wget
curl -X DELETE /api/agents/{agent_id} \
-H 'Authorization: Bearer {access-token}'

DELETE /agents/{agent_id}

Delete a agent

Delete a agent

Parameters#

NameInTypeRequiredDescription
agent_idpathinteger(int64)trueID of agent

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfully deleted agentNone

Response Schema#

get_groups#

Code samples

# You can also use wget
curl -X GET /api/groups \
-H 'Authorization: Bearer {access-token}'

GET /groups

Get groups

Get groups

Parameters#

NameInTypeRequiredDescription
startqueryinteger(int32)falseHow many items to return at one time (max 100)
limitqueryinteger(int32)falseHow many items to return at one time (max 100)

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfullyNone

Response Schema#

create_group#

Code samples

# You can also use wget
curl -X POST /api/groups \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

POST /groups

Create a group

Create a new group

Body parameter

{
"id": 0,
"name": "string",
"project_name": "string",
"project_id": 0,
"agents_count": 0
}

Parameters#

NameInTypeRequiredDescription
bodybodyGroupfalsegroup

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created groupNone

Response Schema#

get_group#

Code samples

# You can also use wget
curl -X GET /api/groups/{group_id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /groups/{group_id}

Get group

Get group details

Parameters#

NameInTypeRequiredDescription
group_idpathinteger(int64)trueID of group

Example responses

200 Response

{
"id": 0,
"name": "string",
"project_name": "string",
"project_id": 0,
"agents_count": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKGroup detailsGroup

update_group#

Code samples

# You can also use wget
curl -X PUT /api/groups/{group_id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /groups/{group_id}

Update a group

Update group settings

Body parameter

{
"id": 0,
"name": "string",
"project_name": "string",
"project_id": 0,
"agents_count": 0
}

Parameters#

NameInTypeRequiredDescription
group_idpathinteger(int64)trueID of group
bodybodyGroupfalsegroup

Example responses

200 Response

{
"id": 0,
"name": "string",
"project_name": "string",
"project_id": 0,
"agents_count": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfullyGroup

delete_group#

Code samples

# You can also use wget
curl -X DELETE /api/groups/{group_id} \
-H 'Authorization: Bearer {access-token}'

DELETE /groups/{group_id}

Delete a group

Gelete group settings

Parameters#

NameInTypeRequiredDescription
group_idpathinteger(int64)trueID of group

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfullyNone

Response Schema#

get_aws_ec2_regions#

Code samples

# You can also use wget
curl -X GET /api/aws-ec2-regions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /aws-ec2-regions

Get settings

Get settings details

Example responses

200 Response

{
"items": [
{
"Endpoint": "string",
"RegionName": "string",
"OptInStatus": "string"
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKSettings detailsAwsEc2Regions

get_aws_ec2_instance_types#

Code samples

# You can also use wget
curl -X GET /api/aws-ec2-instance-types/{region} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /aws-ec2-instance-types/{region}

Get settings

Get settings details

Parameters#

NameInTypeRequiredDescription
regionpathstringtrueID of group

Example responses

200 Response

{
"items": [
{
"InstanceType": "string"
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKSettings detailsAwsEc2InstanceTypes

get_settings#

Code samples

# You can also use wget
curl -X GET /api/settings \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /settings

Get settings

Get settings details

Example responses

200 Response

{
"general": {},
"notification": {},
"monitoring": {}
}

Responses#

StatusMeaningDescriptionSchema
200OKSettings detailsSettings

update_settings#

Code samples

# You can also use wget
curl -X PUT /api/settings \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /settings

Update a project

Update project settings

Body parameter

{
"general": {},
"notification": {},
"monitoring": {}
}

Parameters#

NameInTypeRequiredDescription
bodybodySettingsfalsesettings details

Example responses

200 Response

{
"general": {},
"notification": {},
"monitoring": {}
}

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfullySettings

get_diagnostics#

Code samples

# You can also use wget
curl -X GET /api/diagnostics \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /diagnostics

Get health status of Kraken services.

Get health status of Kraken services.

Example responses

200 Response

{}

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfullyDiagnostics

Execution#

get_flows#

Code samples

# You can also use wget
curl -X GET /api/branches/{branch_id}/flows/{kind} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /branches/{branch_id}/flows/{kind}

List all runs

Parameters#

NameInTypeRequiredDescription
branch_idpathinteger(int64)trueID of pet to return
kindpathstringtrueID of pet to return
startqueryinteger(int32)falseHow many items to return at one time (max 100)
limitqueryinteger(int32)falseHow many items to return at one time (max 100)
middlequeryinteger(int32)falseMiddle

Example responses

200 Response

{
"items": [
{
"id": 0,
"label": "string",
"branch_id": 0,
"created": "2019-08-24T14:15:22Z",
"project_id": 0,
"project_name": "string",
"base_branch_name": "string",
"branch_name": "string",
"runs": {},
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"args": {},
"kind": "string",
"artifacts": {
"public": {
"count": 0
}
}
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsFlows
defaultDefaultunexpected errorApiError

create_flow#

Code samples

# You can also use wget
curl -X POST /api/branches/{branch_id}/flows/{kind} \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

POST /branches/{branch_id}/flows/{kind}

Create a run

Create a new run

Body parameter

{
"id": 0,
"label": "string",
"branch_id": 0,
"created": "2019-08-24T14:15:22Z",
"project_id": 0,
"project_name": "string",
"base_branch_name": "string",
"branch_name": "string",
"runs": {},
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"args": {},
"kind": "string",
"artifacts": {
"public": {
"count": 0
}
}
}

Parameters#

NameInTypeRequiredDescription
branch_idpathinteger(int64)trueID of pet to return
kindpathstringtrueID of pet to return
bodybodyFlowfalseflow

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runNone

Response Schema#

get_flow#

Code samples

# You can also use wget
curl -X GET /api/flows/{flow_id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /flows/{flow_id}

List all results

Parameters#

NameInTypeRequiredDescription
flow_idpathinteger(int64)trueID of pet to return

Example responses

200 Response

{
"id": 0,
"label": "string",
"branch_id": 0,
"created": "2019-08-24T14:15:22Z",
"project_id": 0,
"project_name": "string",
"base_branch_name": "string",
"branch_name": "string",
"runs": {},
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"args": {},
"kind": "string",
"artifacts": {
"public": {
"count": 0
}
}
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsFlow
defaultDefaultunexpected errorApiError

get_flow_runs#

Code samples

# You can also use wget
curl -X GET /api/flows/{flow_id}/runs \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /flows/{flow_id}/runs

List all results

Parameters#

NameInTypeRequiredDescription
flow_idpathinteger(int64)trueID of pet to return

Example responses

200 Response

{
"items": [
{
"id": 0,
"label": "string",
"project_id": 0,
"project_name": "string",
"branch_id": 0,
"branch_name": "string",
"flow_id": 0,
"stage_id": 0,
"stage_name": "string",
"args": {},
"flow_kind": "string",
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"duration": "string",
"state": "string",
"jobs_error": 0,
"jobs_rerun": 0,
"jobs_waiting": 0,
"jobs_executing": 0,
"jobs_processing": 0,
"jobs_total": 0,
"tests_not_run": 0,
"tests_passed": 0,
"tests_total": 0,
"issues_total": 0,
"issues_new": 0,
"artifacts_total": 0,
"fix_cnt": 0,
"regr_cnt": 0,
"repo_data": {},
"reason": "string"
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsRuns
defaultDefaultunexpected errorApiError

create_run#

Code samples

# You can also use wget
curl -X POST /api/flows/{flow_id}/runs \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

POST /flows/{flow_id}/runs

Create a run

Create a new run

Body parameter

{
"id": 0,
"label": "string",
"project_id": 0,
"project_name": "string",
"branch_id": 0,
"branch_name": "string",
"flow_id": 0,
"stage_id": 0,
"stage_name": "string",
"args": {},
"flow_kind": "string",
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"duration": "string",
"state": "string",
"jobs_error": 0,
"jobs_rerun": 0,
"jobs_waiting": 0,
"jobs_executing": 0,
"jobs_processing": 0,
"jobs_total": 0,
"tests_not_run": 0,
"tests_passed": 0,
"tests_total": 0,
"issues_total": 0,
"issues_new": 0,
"artifacts_total": 0,
"fix_cnt": 0,
"regr_cnt": 0,
"repo_data": {},
"reason": "string"
}

Parameters#

NameInTypeRequiredDescription
flow_idpathinteger(int64)trueID of pet to return
bodybodyRunfalserun

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runNone

Response Schema#

get_flow_artifacts#

Code samples

# You can also use wget
curl -X GET /api/flows/{flow_id}/artifacts \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /flows/{flow_id}/artifacts

List artifacts of given flow

Parameters#

NameInTypeRequiredDescription
flow_idpathinteger(int64)trueID of pet to return

Example responses

200 Response

{
"items": [
{
"id": 0,
"flow_id": 0,
"run_id": 0,
"size": 0,
"path": "string"
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsArtifacts
defaultDefaultunexpected errorApiError

get_runs#

Code samples

# You can also use wget
curl -X GET /api/stages/{stage_id}/runs \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /stages/{stage_id}/runs

List all runs

Parameters#

NameInTypeRequiredDescription
stage_idpathinteger(int64)trueID of pet to return
limitqueryinteger(int32)falseHow many items to return at one time (max 100)

Example responses

200 Response

{
"items": [
{
"id": 0,
"label": "string",
"project_id": 0,
"project_name": "string",
"branch_id": 0,
"branch_name": "string",
"flow_id": 0,
"stage_id": 0,
"stage_name": "string",
"args": {},
"flow_kind": "string",
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"duration": "string",
"state": "string",
"jobs_error": 0,
"jobs_rerun": 0,
"jobs_waiting": 0,
"jobs_executing": 0,
"jobs_processing": 0,
"jobs_total": 0,
"tests_not_run": 0,
"tests_passed": 0,
"tests_total": 0,
"issues_total": 0,
"issues_new": 0,
"artifacts_total": 0,
"fix_cnt": 0,
"regr_cnt": 0,
"repo_data": {},
"reason": "string"
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsRuns
defaultDefaultunexpected errorApiError

get_run_results#

Code samples

# You can also use wget
curl -X GET /api/runs/{run_id}/results \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /runs/{run_id}/results

List all results

Parameters#

NameInTypeRequiredDescription
run_idpathinteger(int64)trueID of pet to return
startqueryinteger(int32)falseHow many items to return at one time (max 100)
limitqueryinteger(int32)falseHow many items to return at one time (max 100)
sort_fieldquerystringfalsenone
sort_dirquerystringfalsenone
statusesqueryarray[integer]falsenone
changesqueryarray[integer]falsenone
min_agequeryintegerfalsenone
max_agequeryintegerfalsenone
min_instabilityqueryintegerfalsenone
max_instabilityqueryintegerfalsenone
test_case_textquerystringfalsenone
jobquerystringfalsenone

Example responses

200 Response

{
"items": [
{
"id": 0,
"job_id": 0,
"values": {}
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsResults
defaultDefaultunexpected errorApiError

get_run_jobs#

Code samples

# You can also use wget
curl -X GET /api/runs/{run_id}/jobs \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /runs/{run_id}/jobs

List jobs

Parameters#

NameInTypeRequiredDescription
run_idpathinteger(int64)trueID of pet to return
startqueryinteger(int32)falseHow many items to return at one time (max 100)
limitqueryinteger(int32)falseHow many items to return at one time (max 100)
include_coveredquerybooleanfalseInclude covered jobs

Example responses

200 Response

{
"items": [
{
"id": 0,
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"finished": "2019-08-24T14:15:22Z",
"completed": "2019-08-24T14:15:22Z",
"duration": "string",
"timeout": 0,
"name": "string",
"state": 0,
"completion_status": 0,
"notes": "string",
"run_id": 0,
"steps": [
{}
],
"agents_group_id": 0,
"agents_group_name": "string",
"agent_id": 0,
"agent_name": "string",
"executor": "string",
"system": "string"
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsJobs
defaultDefaultunexpected errorApiError

get_run_issues#

Code samples

# You can also use wget
curl -X GET /api/runs/{run_id}/issues \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /runs/{run_id}/issues

List run issues

Parameters#

NameInTypeRequiredDescription
run_idpathinteger(int64)trueID of pet to return
startqueryinteger(int32)falseHow many items to return at one time (max 100)
limitqueryinteger(int32)falseHow many items to return at one time (max 100)
issue_typesqueryarray[integer]falsenone
locationquerystringfalsenone
messagequerystringfalsenone
symbolquerystringfalsenone
min_agequeryintegerfalsenone
max_agequeryintegerfalsenone
jobquerystringfalsenone

Example responses

200 Response

{
"items": [
{
"id": 0,
"job_id": 0,
"job_name": "string"
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsIssues
defaultDefaultunexpected errorApiError

get_run_artifacts#

Code samples

# You can also use wget
curl -X GET /api/runs/{run_id}/artifacts \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /runs/{run_id}/artifacts

List artifacts of given run

Parameters#

NameInTypeRequiredDescription
run_idpathinteger(int64)trueID of pet to return
startqueryinteger(int32)falseHow many items to return at one time (max 100)
limitqueryinteger(int32)falseHow many items to return at one time (max 100)

Example responses

200 Response

{
"items": [
{
"id": 0,
"flow_id": 0,
"run_id": 0,
"size": 0,
"path": "string"
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsArtifacts
defaultDefaultunexpected errorApiError

get_run#

Code samples

# You can also use wget
curl -X GET /api/runs/{run_id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /runs/{run_id}

List all results

Parameters#

NameInTypeRequiredDescription
run_idpathinteger(int64)trueID of pet to return

Example responses

200 Response

{
"id": 0,
"label": "string",
"project_id": 0,
"project_name": "string",
"branch_id": 0,
"branch_name": "string",
"flow_id": 0,
"stage_id": 0,
"stage_name": "string",
"args": {},
"flow_kind": "string",
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"duration": "string",
"state": "string",
"jobs_error": 0,
"jobs_rerun": 0,
"jobs_waiting": 0,
"jobs_executing": 0,
"jobs_processing": 0,
"jobs_total": 0,
"tests_not_run": 0,
"tests_passed": 0,
"tests_total": 0,
"issues_total": 0,
"issues_new": 0,
"artifacts_total": 0,
"fix_cnt": 0,
"regr_cnt": 0,
"repo_data": {},
"reason": "string"
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsRun
defaultDefaultunexpected errorApiError

run_run_jobs#

Code samples

# You can also use wget
curl -X PUT /api/runs/{run_id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /runs/{run_id}

Start manual run or replay existing run ie. start again same jobs

Parameters#

NameInTypeRequiredDescription
run_idpathinteger(int64)trueID of pet to return

Example responses

200 Response

{
"id": 0,
"label": "string",
"project_id": 0,
"project_name": "string",
"branch_id": 0,
"branch_name": "string",
"flow_id": 0,
"stage_id": 0,
"stage_name": "string",
"args": {},
"flow_kind": "string",
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"duration": "string",
"state": "string",
"jobs_error": 0,
"jobs_rerun": 0,
"jobs_waiting": 0,
"jobs_executing": 0,
"jobs_processing": 0,
"jobs_total": 0,
"tests_not_run": 0,
"tests_passed": 0,
"tests_total": 0,
"issues_total": 0,
"issues_new": 0,
"artifacts_total": 0,
"fix_cnt": 0,
"regr_cnt": 0,
"repo_data": {},
"reason": "string"
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsRun
defaultDefaultunexpected errorApiError

cancel_run#

Code samples

# You can also use wget
curl -X DELETE /api/runs/{run_id} \
-H 'Authorization: Bearer {access-token}'

DELETE /runs/{run_id}

Cancel a run

Cancel a run

Parameters#

NameInTypeRequiredDescription
run_idpathinteger(int64)trueID of run

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfully deleted jobNone

Response Schema#

get_result#

Code samples

# You can also use wget
curl -X GET /api/test_case_results/{test_case_result_id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /test_case_results/{test_case_result_id}

List all results

Parameters#

NameInTypeRequiredDescription
test_case_result_idpathinteger(int64)trueID of pet to return

Example responses

200 Response

{
"id": 0,
"job_id": 0,
"values": {}
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsResult
defaultDefaultunexpected errorApiError

get_result_history#

Code samples

# You can also use wget
curl -X GET /api/test_case_results/{test_case_result_id}/history \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /test_case_results/{test_case_result_id}/history

List all results

Parameters#

NameInTypeRequiredDescription
test_case_result_idpathinteger(int64)trueID of pet to return
startqueryinteger(int32)falseHow many items to return at one time (max 100)
limitqueryinteger(int32)falseHow many items to return at one time (max 100)

Example responses

200 Response

{
"items": [
{
"id": 0,
"job_id": 0,
"values": {}
}
],
"total": 0
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsResults
defaultDefaultunexpected errorApiError

create_job#

Code samples

# You can also use wget
curl -X POST /api/jobs \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'

POST /jobs

Create a job

Create a new job

Body parameter

{
"run": 0
}

Parameters#

NameInTypeRequiredDescription
bodybodyobjectfalseJob to create
» runbodyintegertruenone

Example responses

Responses#

StatusMeaningDescriptionSchema
201CreatedSuccessfully created runNone

Response Schema#

job_rerun#

Code samples

# You can also use wget
curl -X PUT /api/jobs/{job_id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

PUT /jobs/{job_id}

Rerun a job

Parameters#

NameInTypeRequiredDescription
job_idpathinteger(int64)trueID of pet to return

Example responses

200 Response

{
"id": 0,
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"finished": "2019-08-24T14:15:22Z",
"completed": "2019-08-24T14:15:22Z",
"duration": "string",
"timeout": 0,
"name": "string",
"state": 0,
"completion_status": 0,
"notes": "string",
"run_id": 0,
"steps": [
{}
],
"agents_group_id": 0,
"agents_group_name": "string",
"agent_id": 0,
"agent_name": "string",
"executor": "string",
"system": "string"
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of runsJob
defaultDefaultunexpected errorApiError

delete_job#

Code samples

# You can also use wget
curl -X DELETE /api/jobs/{job_id} \
-H 'Authorization: Bearer {access-token}'

DELETE /jobs/{job_id}

Cancel a job

Cancel a job

Parameters#

NameInTypeRequiredDescription
job_idpathinteger(int64)trueID of job

Example responses

Responses#

StatusMeaningDescriptionSchema
200OKSuccessfully deleted jobNone

Response Schema#

get_job_logs#

Code samples

# You can also use wget
curl -X GET /api/jobs/{job_id}/logs?start=0&limit=0 \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

GET /jobs/{job_id}/logs

Get a job logs

Get a job logs

Parameters#

NameInTypeRequiredDescription
job_idpathintegertrueID of pet to return
startqueryintegertrueID of pet to return
limitqueryintegertrueID of pet to return
orderquerystringfalseID of pet to return
internalsquerybooleanfalseID of pet to return
filtersquerystringfalseID of pet to return

Example responses

200 Response

{
"items": [
{
"time": "string",
"message": "string",
"service": "string",
"host": "string",
"level": "string",
"job": 0,
"tool": "string",
"step": 0
}
],
"total": 0,
"bookmarks": {
"first": "string",
"last": "string"
},
"job": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"finished": "2019-08-24T14:15:22Z",
"completed": "2019-08-24T14:15:22Z",
"duration": "string",
"timeout": 0,
"name": "string",
"state": 0,
"completion_status": 0,
"notes": "string",
"run_id": 0,
"steps": [
{}
],
"agents_group_id": 0,
"agents_group_name": "string",
"agent_id": 0,
"agent_name": "string",
"executor": "string",
"system": "string"
}
}

Responses#

StatusMeaningDescriptionSchema
200OKA paged array of logsLogs
defaultDefaultunexpected errorApiError

Schemas#

Session#

{
"id": 0,
"token": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
tokenstringfalsenonenone

UserPassword#

{
"password_old": "string",
"password_new": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
password_oldstringfalsenonenone
password_newstringfalsenonenone

Flow#

{
"id": 0,
"label": "string",
"branch_id": 0,
"created": "2019-08-24T14:15:22Z",
"project_id": 0,
"project_name": "string",
"base_branch_name": "string",
"branch_name": "string",
"runs": {},
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"args": {},
"kind": "string",
"artifacts": {
"public": {
"count": 0
}
}
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
labelstringfalsenonenone
branch_idinteger(int64)falsenonenone
createdstring(date-time)falsenonenone
project_idinteger(int64)falsenonenone
project_namestringfalsenonenone
base_branch_namestringfalsenonenone
branch_namestringfalsenonenone
runsobjectfalsenonenone
stages[Stage]falsenonenone
argsobjectfalsenonenone
kindstringfalsenonenone
artifactsobjectfalsenonenone
» publicobjectfalsenonenone
»» countinteger(int64)falsenonenone

Flows#

{
"items": [
{
"id": 0,
"label": "string",
"branch_id": 0,
"created": "2019-08-24T14:15:22Z",
"project_id": 0,
"project_name": "string",
"base_branch_name": "string",
"branch_name": "string",
"runs": {},
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"args": {},
"kind": "string",
"artifacts": {
"public": {
"count": 0
}
}
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Flow]falsenonenone
totalinteger(int64)falsenonenone

Run#

{
"id": 0,
"label": "string",
"project_id": 0,
"project_name": "string",
"branch_id": 0,
"branch_name": "string",
"flow_id": 0,
"stage_id": 0,
"stage_name": "string",
"args": {},
"flow_kind": "string",
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"duration": "string",
"state": "string",
"jobs_error": 0,
"jobs_rerun": 0,
"jobs_waiting": 0,
"jobs_executing": 0,
"jobs_processing": 0,
"jobs_total": 0,
"tests_not_run": 0,
"tests_passed": 0,
"tests_total": 0,
"issues_total": 0,
"issues_new": 0,
"artifacts_total": 0,
"fix_cnt": 0,
"regr_cnt": 0,
"repo_data": {},
"reason": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
labelstringfalsenonenone
project_idinteger(int64)falsenonenone
project_namestringfalsenonenone
branch_idinteger(int64)falsenonenone
branch_namestringfalsenonenone
flow_idinteger(int64)falsenonenone
stage_idinteger(int64)falsenonenone
stage_namestringfalsenonenone
argsobjectfalsenonenone
flow_kindstringfalsenonenone
createdstring(date-time)falsenonenone
startedstring(date-time)falsenonenone
durationstringfalsenonenone
statestringfalsenonenone
jobs_errorintegerfalsenonenone
jobs_rerunintegerfalsenonenone
jobs_waitingintegerfalsenonenone
jobs_executingintegerfalsenonenone
jobs_processingintegerfalsenonenone
jobs_totalintegerfalsenonenone
tests_not_runintegerfalsenonenone
tests_passedintegerfalsenonenone
tests_totalintegerfalsenonenone
issues_totalintegerfalsenonenone
issues_newintegerfalsenonenone
artifacts_totalintegerfalsenonenone
fix_cntintegerfalsenonenone
regr_cntintegerfalsenonenone
repo_dataobjectfalsenonenone
reasonstringfalsenonenone

Runs#

{
"items": [
{
"id": 0,
"label": "string",
"project_id": 0,
"project_name": "string",
"branch_id": 0,
"branch_name": "string",
"flow_id": 0,
"stage_id": 0,
"stage_name": "string",
"args": {},
"flow_kind": "string",
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"duration": "string",
"state": "string",
"jobs_error": 0,
"jobs_rerun": 0,
"jobs_waiting": 0,
"jobs_executing": 0,
"jobs_processing": 0,
"jobs_total": 0,
"tests_not_run": 0,
"tests_passed": 0,
"tests_total": 0,
"issues_total": 0,
"issues_new": 0,
"artifacts_total": 0,
"fix_cnt": 0,
"regr_cnt": 0,
"repo_data": {},
"reason": "string"
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Run]falsenonenone
totalinteger(int64)falsenonenone

Result#

{
"id": 0,
"job_id": 0,
"values": {}
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)truenonenone
job_idinteger(int64)truenonenone
valuesobjectfalsenonenone

Results#

{
"items": [
{
"id": 0,
"job_id": 0,
"values": {}
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Result]falsenonenone
totalinteger(int64)falsenonenone

Issue#

{
"id": 0,
"job_id": 0,
"job_name": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)truenonenone
job_idinteger(int64)truenonenone
job_namestringfalsenonenone

Issues#

{
"items": [
{
"id": 0,
"job_id": 0,
"job_name": "string"
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Issue]falsenonenone
totalinteger(int64)falsenonenone

Artifact#

{
"id": 0,
"flow_id": 0,
"run_id": 0,
"size": 0,
"path": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
flow_idinteger(int64)falsenonenone
run_idinteger(int64)falsenonenone
sizeintegerfalsenonenone
pathstringfalsenonenone

Artifacts#

{
"items": [
{
"id": 0,
"flow_id": 0,
"run_id": 0,
"size": 0,
"path": "string"
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Artifact]falsenonenone
totalinteger(int64)falsenonenone

Log#

{
"time": "string",
"message": "string",
"service": "string",
"host": "string",
"level": "string",
"job": 0,
"tool": "string",
"step": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
timestringfalsenonenone
messagestringfalsenonenone
servicestringfalsenonenone
hoststringfalsenonenone
levelstringfalsenonenone
jobintegerfalsenonenone
toolstringfalsenonenone
stepintegerfalsenonenone

Logs#

{
"items": [
{
"time": "string",
"message": "string",
"service": "string",
"host": "string",
"level": "string",
"job": 0,
"tool": "string",
"step": 0
}
],
"total": 0,
"bookmarks": {
"first": "string",
"last": "string"
},
"job": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"finished": "2019-08-24T14:15:22Z",
"completed": "2019-08-24T14:15:22Z",
"duration": "string",
"timeout": 0,
"name": "string",
"state": 0,
"completion_status": 0,
"notes": "string",
"run_id": 0,
"steps": [
{}
],
"agents_group_id": 0,
"agents_group_name": "string",
"agent_id": 0,
"agent_name": "string",
"executor": "string",
"system": "string"
}
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Log]falsenonenone
totalinteger(int64)falsenonenone
bookmarksobjectfalsenonenone
» firststringfalsenonenone
» laststringfalsenonenone
jobJobfalsenonenone

CeleryTaskNames#

{
"items": [
{
"time": "string",
"name": "string",
"lines": 0
}
]
}

Properties#

NameTypeRequiredRestrictionsDescription
items[object]falsenonenone
» timestringfalsenonenone
» namestringfalsenonenone
» linesinteger(int64)falsenonenone

ServicesLog#

{
"time": "string",
"message": "string",
"service": "string",
"host": "string",
"level": "string",
"tool": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
timestringfalsenonenone
messagestringfalsenonenone
servicestringfalsenonenone
hoststringfalsenonenone
levelstringfalsenonenone
toolstringfalsenonenone

ServicesLogs#

{
"items": [
{
"time": "string",
"message": "string",
"service": "string",
"host": "string",
"level": "string",
"tool": "string"
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[ServicesLog]falsenonenone
totalinteger(int64)falsenonenone

ErrorsInLogsCount#

{
"errors_count": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
errors_countinteger(int64)falsenonenone

Job#

{
"id": 0,
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"finished": "2019-08-24T14:15:22Z",
"completed": "2019-08-24T14:15:22Z",
"duration": "string",
"timeout": 0,
"name": "string",
"state": 0,
"completion_status": 0,
"notes": "string",
"run_id": 0,
"steps": [
{}
],
"agents_group_id": 0,
"agents_group_name": "string",
"agent_id": 0,
"agent_name": "string",
"executor": "string",
"system": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
idintegerfalsenonenone
createdstring(date-time)falsenonenone
startedstring(date-time)falsenonenone
finishedstring(date-time)falsenonenone
completedstring(date-time)falsenonenone
durationstringfalsenonenone
timeoutintegerfalsenonenone
namestringfalsenonenone
stateintegerfalsenonenone
completion_statusintegerfalsenonenone
notesstringfalsenonenone
run_idintegerfalsenonenone
steps[object]falsenonenone
agents_group_idintegerfalsenonenone
agents_group_namestringfalsenonenone
agent_idintegerfalsenonenone
agent_namestringfalsenonenone
executorstringfalsenonenone
systemstringfalsenonenone

Jobs#

{
"items": [
{
"id": 0,
"created": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"finished": "2019-08-24T14:15:22Z",
"completed": "2019-08-24T14:15:22Z",
"duration": "string",
"timeout": 0,
"name": "string",
"state": 0,
"completion_status": 0,
"notes": "string",
"run_id": 0,
"steps": [
{}
],
"agents_group_id": 0,
"agents_group_name": "string",
"agent_id": 0,
"agent_name": "string",
"executor": "string",
"system": "string"
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Job]falsenonenone
totalinteger(int64)falsenonenone

Project#

{
"id": 0,
"name": "string",
"webhooks": {},
"branches": [
{}
]
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
namestringfalsenonenone
webhooksobjectfalsenonenone
branches[object]falsenonenone

Projects#

{
"items": [
{
"id": 0,
"name": "string",
"webhooks": {},
"branches": [
{}
]
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Project]falsenonenone
totalinteger(int64)falsenonenone

Secret#

{
"id": 0,
"name": "string",
"project_id": 0,
"project_name": "string",
"kind": "string",
"username": "string",
"key": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
namestringfalsenonenone
project_idinteger(int64)falsenonenone
project_namestringfalsenonenone
kindstringfalsenonenone
usernamestringfalsenonenone
keystringfalsenonenone

Branch#

{
"id": 0,
"name": "string",
"branch_name": "string",
"project_id": 0,
"project_name": "string",
"stages": [
{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}
],
"flows": {}
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
namestringtruenonenone
branch_namestringfalsenonenone
project_idinteger(int64)falsenonenone
project_namestringfalsenonenone
stages[Stage]falsenonenone
flowsobjectfalsenonenone

BranchSequence#

{
"id": 0,
"branch_name": "string",
"branch_id": 0,
"stage_name": "string",
"stage_id": 0,
"kind": 0,
"value": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
branch_namestringfalsenonenone
branch_idinteger(int64)falsenonenone
stage_namestringfalsenonenone
stage_idinteger(int64)falsenonenone
kindinteger(int64)falsenonenone
valueinteger(int64)falsenonenone

BranchSequences#

{
"items": [
{
"id": 0,
"branch_name": "string",
"branch_id": 0,
"stage_name": "string",
"stage_id": 0,
"kind": 0,
"value": 0
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[BranchSequence]falsenonenone
totalinteger(int64)falsenonenone

Stage#

{
"id": 0,
"name": "string",
"branch_id": 0,
"branch_name": "string",
"schema": {
"parent": "string",
"triggers": {
"parent": true
},
"parameters": [
{
"name": "string",
"default": "string"
}
]
},
"schema_code": "string",
"enabled": true
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
namestringtruenonenone
branch_idinteger(int64)falsenonenone
branch_namestringfalsenonenone
schemaobjectfalsenonenone
» parentstringfalsenonenone
» triggersobjectfalsenonenone
»» parentbooleanfalsenonenone
» parameters[object]falsenonenone
»» namestringfalsenonenone
»» defaultstringfalsenonenone
schema_codestringfalsenonenone
enabledbooleanfalsenonenone

StageSchemaJson#

{
"stage_id": 0,
"schema": "string",
"error": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
stage_idinteger(int64)falsenonenone
schemastringfalsenonenone
errorstringfalsenonenone

StageSchemaCode#

{
"schema_code": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
schema_codestringtruenonenone

StageSchedule#

{
"schedules": [
{
"name": "string",
"job_id": "string",
"next_run_time": "string"
}
]
}

Properties#

NameTypeRequiredRestrictionsDescription
schedules[object]falsenonenone
» namestringfalsenonenone
» job_idstringfalsenonenone
» next_run_timestringfalsenonenone

Agent#

{
"id": 0,
"name": "string",
"address": "string",
"authorized": true,
"ip_address": "string",
"state": 0,
"disabled": true,
"groups": [
{}
],
"job": {},
"last_seen": "2019-08-24T14:15:22Z",
"host_info": {},
"user_attrs": {}
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
namestringfalsenonenone
addressstringfalsenonenone
authorizedbooleanfalsenonenone
ip_addressstringfalsenonenone
stateintegerfalsenonenone
disabledbooleanfalsenonenone
groups[object]falsenonenone
jobobjectfalsenonenone
last_seenstring(date-time)falsenonenone
host_infoobjectfalsenonenone
user_attrsobjectfalsenonenone

Agents#

{
"items": [
{
"id": 0,
"name": "string",
"address": "string",
"authorized": true,
"ip_address": "string",
"state": 0,
"disabled": true,
"groups": [
{}
],
"job": {},
"last_seen": "2019-08-24T14:15:22Z",
"host_info": {},
"user_attrs": {}
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Agent]falsenonenone
totalinteger(int64)falsenonenone

Group#

{
"id": 0,
"name": "string",
"project_name": "string",
"project_id": 0,
"agents_count": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
idinteger(int64)falsenonenone
namestringfalsenonenone
project_namestringfalsenonenone
project_idintegerfalsenonenone
agents_countintegerfalsenonenone

Groups#

{
"items": [
{
"id": 0,
"name": "string",
"project_name": "string",
"project_id": 0,
"agents_count": 0
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[Group]falsenonenone
totalinteger(int64)falsenonenone

AwsEc2Regions#

{
"items": [
{
"Endpoint": "string",
"RegionName": "string",
"OptInStatus": "string"
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[object]falsenonenone
» Endpointstringfalsenonenone
» RegionNamestringfalsenonenone
» OptInStatusstringfalsenonenone
totalinteger(int64)falsenonenone

AwsEc2InstanceTypes#

{
"items": [
{
"InstanceType": "string"
}
],
"total": 0
}

Properties#

NameTypeRequiredRestrictionsDescription
items[object]falsenonenone
» InstanceTypestringfalsenonenone
totalinteger(int64)falsenonenone

Settings#

{
"general": {},
"notification": {},
"monitoring": {}
}

Properties#

NameTypeRequiredRestrictionsDescription
generalobjectfalsenonenone
notificationobjectfalsenonenone
monitoringobjectfalsenonenone

Diagnostics#

{}

Properties#

None

ApiError#

{
"code": 0,
"message": "string"
}

Properties#

NameTypeRequiredRestrictionsDescription
codeinteger(int32)truenonenone
messagestringtruenonenone