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

Management

get_server_version

Code samples

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

GET /version

Get server version

Get server version

Example responses

200 Response

{
  "version": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	ServerVersion

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_systems

Code samples

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

GET /systems

Get systems

Get systems

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	An array of system	Systems
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_projects

Code samples

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

GET /projects

Get projects

Get projects

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_project

Code samples

# You can also use wget
curl -X POST /bk/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

Name	In	Type	Required	Description
body	body	Project	false	project

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_project

Code samples

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

GET /projects/{project_id}

Get project

Get project details

Parameters

Name	In	Type	Required	Description
project_id	path	integer(int64)	true	ID of project
with_results	query	boolean	false	with results

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Project details	Project

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

update_project

Code samples

# You can also use wget
curl -X PUT /bk/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

Name	In	Type	Required	Description
project_id	path	integer(int64)	true	ID of project
body	body	Project	false	project

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	Project

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

delete_project

Code samples

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

DELETE /projects/{project_id}

Delete a project

Delete a project

Parameters

Name	In	Type	Required	Description
project_id	path	integer(int64)	true	ID of project

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully deleted project	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_secret

Code samples

# You can also use wget
curl -X POST /bk/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

Name	In	Type	Required	Description
project_id	path	integer(int64)	true	ID of project
body	body	Secret	false	secret

Example responses

201 Response

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

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	Secret

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

update_secret

Code samples

# You can also use wget
curl -X PUT /bk/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

Name	In	Type	Required	Description
secret_id	path	integer(int64)	true	ID of secret
body	body	Secret	false	secret

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

delete_secret

Code samples

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

DELETE /secrets/{secret_id}

Delete a secret

Delete a secret

Parameters

Name	In	Type	Required	Description
secret_id	path	integer(int64)	true	ID of secret

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully deleted secret	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_branch

Code samples

# You can also use wget
curl -X POST /bk/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,
  "created": "2019-08-24T14:15:22Z",
  "name": "string",
  "branch_name": "string",
  "project_id": 0,
  "project_name": "string",
  "forking_model": "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": {},
  "retention_policy": {
    "ci_logs": 0,
    "dev_logs": 0,
    "ci_artifacts": 0,
    "dev_artifacts": 0
  }
}

Parameters

Name	In	Type	Required	Description
project_id	path	integer(int64)	true	ID of pet to return
body	body	Branch	false	branch

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_workflow_schema

Code samples

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

GET /workflow-schema

Get workflow schema

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Workflow schema	Inline
default	Default	unexpected error	ApiError

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

update_branch

Code samples

# You can also use wget
curl -X PUT /bk/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,
  "created": "2019-08-24T14:15:22Z",
  "name": "string",
  "branch_name": "string",
  "project_id": 0,
  "project_name": "string",
  "forking_model": "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": {},
  "retention_policy": {
    "ci_logs": 0,
    "dev_logs": 0,
    "ci_artifacts": 0,
    "dev_artifacts": 0
  }
}

Parameters

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID of branch
body	body	Branch	false	branch

Example responses

200 Response

{
  "id": 0,
  "created": "2019-08-24T14:15:22Z",
  "name": "string",
  "branch_name": "string",
  "project_id": 0,
  "project_name": "string",
  "forking_model": "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": {},
  "retention_policy": {
    "ci_logs": 0,
    "dev_logs": 0,
    "ci_artifacts": 0,
    "dev_artifacts": 0
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	Branch

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

delete_branch

Code samples

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

DELETE /branches/{branch_id}

Delete a branch

Delete a branch

Parameters

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID of branch

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully deleted branch	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_branch

Code samples

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

GET /branches/{branch_id}/cfg

List all results

Parameters

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID of pet to return

Example responses

200 Response

{
  "id": 0,
  "created": "2019-08-24T14:15:22Z",
  "name": "string",
  "branch_name": "string",
  "project_id": 0,
  "project_name": "string",
  "forking_model": "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": {},
  "retention_policy": {
    "ci_logs": 0,
    "dev_logs": 0,
    "ci_artifacts": 0,
    "dev_artifacts": 0
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Branch
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_branch_sequences

Code samples

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

GET /branches/{branch_id}/sequences

List branch sequences

Parameters

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID 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

Status	Meaning	Description	Schema
200	OK	An array of branch sequences	BranchSequences
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

update_branch_sequence

Code samples

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

PUT /sequences/{seq_id}

Set branch sequence value

Body parameter

{
  "value": 0
}

Parameters

Name	In	Type	Required	Description
seq_id	path	integer(int64)	true	ID of sequence
body	body	object	false	Value
» value	body	integer(int64)	false	none

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	An array of branch sequences	BranchSequence
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_branch_stats

Code samples

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

GET /branches/{branch_id}/stats

Stats of a branch

Parameters

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID of branch

Example responses

200 Response

{
  "id": 0,
  "ci": {
    "flows_total": 0,
    "flows_last_week": 0,
    "flows_last_month": 0,
    "avg_duration_last_month": 0,
    "avg_duration_last_week": 0,
    "durations": [
      {
        "flow_label": "string",
        "duration": 0
      }
    ]
  },
  "dev": {
    "flows_total": 0,
    "flows_last_week": 0,
    "flows_last_month": 0,
    "avg_duration_last_month": 0,
    "avg_duration_last_week": 0,
    "durations": [
      {
        "flow_label": "string",
        "duration": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Branch stats	BranchStats
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_stage

Code samples

# You can also use wget
curl -X POST /bk/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

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID of pet to return
body	body	Stage	false	stage

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

move_branch

Code samples

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

PUT /branches/{branch_id}/project_id

Move a branch to another project

Move a branch to another project

Body parameter

{
  "project_id": 0
}

Parameters

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID of branch
body	body	object	true	project id
» project_id	body	integer(int64)	false	none

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

update_branch_retention_policy

Code samples

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

PUT /branches/{branch_id}/retention_policy

Update branch retention policy

Update branch retention policy

Body parameter

{
  "ci_logs": 0,
  "dev_logs": 0,
  "ci_artifacts": 0,
  "dev_artifacts": 0
}

Parameters

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID of branch
body	body	RetentionPolicy	true	retention policy details

Example responses

default Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successfully created run	None
default	Default	unexpected error	ApiError

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_stage

Code samples

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

GET /stages/{stage_id}

Get a stage

Get stage settings

Parameters

Name	In	Type	Required	Description
stage_id	path	integer(int64)	true	ID of pet to return

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

update_stage

Code samples

# You can also use wget
curl -X PUT /bk/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

Name	In	Type	Required	Description
stage_id	path	integer(int64)	true	ID of pet to return
body	body	Stage	true	stage

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

delete_stage

Code samples

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

DELETE /stages/{stage_id}

Delete a stage

Delete a stage

Parameters

Name	In	Type	Required	Description
stage_id	path	integer(int64)	true	ID of pet to return

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully deleted stage	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_stage_schema_as_json

Code samples

# You can also use wget
curl -X PUT /bk/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

Name	In	Type	Required	Description
stage_id	path	integer(int64)	true	ID of pet to return
body	body	StageSchemaCode	false	Schema code to execute

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	StageSchemaJson
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_stage_schedule

Code samples

# You can also use wget
curl -X GET /bk/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

Name	In	Type	Required	Description
stage_id	path	integer(int64)	true	Stage ID

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	An array of schedules	StageSchedule
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_last_rq_jobs_names

Code samples

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

GET /last-rq-jobs

Get rq logs

Get last rq jobs names

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of logs	RQJobNames
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_services_logs

Code samples

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

GET /services-logs

Get services logs

Get services logs

Parameters

Name	In	Type	Required	Description
services	query	array[string]	false	ID of pet to return
level	query	string	false	log level

Example responses

200 Response

{
  "items": [
    {
      "time": "string",
      "message": "string",
      "service": "string",
      "host": "string",
      "path": "string",
      "lineno": "string",
      "level": "string",
      "branch": "string",
      "flow_kind": "string",
      "flow": "string",
      "run": "string",
      "job": "string",
      "tool": "string",
      "step": "string",
      "agent": "string"
    }
  ],
  "total": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of logs	ServicesLogs
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_live_data

Code samples

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

GET /live-data

Get errors in logs count in the last hour

Get errors in logs count in the last hour

Example responses

200 Response

{
  "error_logs_count": 0,
  "authorized_agents": 0,
  "non_authorized_agents": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of logs	LiveData
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_agents

Code samples

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

GET /agents

Get agents

Get agents

Parameters

Name	In	Type	Required	Description
unauthorized	query	boolean	false	ID of pet to return
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)
sort_field	query	string	false	none
sort_dir	query	string	false	none

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

Status	Meaning	Description	Schema
200	OK	A paged array of logs	Agents
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

update_agents

Code samples

# You can also use wget
curl -X PATCH /bk/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

Name	In	Type	Required	Description
body	body	Agent	false	List 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

Status	Meaning	Description	Schema
200	OK	A paged array of logs	Agents
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_agent

Code samples

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

GET /agents/{agent_id}

Get agent

Get agent details

Parameters

Name	In	Type	Required	Description
agent_id	path	integer(int64)	true	ID 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

Status	Meaning	Description	Schema
200	OK	Agent details	Agent

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

update_agent

Code samples

# You can also use wget
curl -X PUT /bk/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

Name	In	Type	Required	Description
agent_id	path	integer(int64)	true	ID of agent
body	body	Agent	false	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

Status	Meaning	Description	Schema
200	OK	Successfully	Agent

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

delete_agent

Code samples

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

DELETE /agents/{agent_id}

Delete a agent

Delete a agent

Parameters

Name	In	Type	Required	Description
agent_id	path	integer(int64)	true	ID of agent

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully deleted agent	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_groups

Code samples

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

GET /groups

Get groups

Get groups

Parameters

Name	In	Type	Required	Description
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_group

Code samples

# You can also use wget
curl -X POST /bk/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

Name	In	Type	Required	Description
body	body	Group	false	group

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created group	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_group

Code samples

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

GET /groups/{group_id}

Get group

Get group details

Parameters

Name	In	Type	Required	Description
group_id	path	integer(int64)	true	ID of group

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Group details	Group

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

update_group

Code samples

# You can also use wget
curl -X PUT /bk/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

Name	In	Type	Required	Description
group_id	path	integer(int64)	true	ID of group
body	body	Group	false	group

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	Group

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

delete_group

Code samples

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

DELETE /groups/{group_id}

Delete a group

Gelete group settings

Parameters

Name	In	Type	Required	Description
group_id	path	integer(int64)	true	ID of group

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_aws_ec2_regions

Code samples

# You can also use wget
curl -X GET /bk/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

Status	Meaning	Description	Schema
200	OK	Settings details	AwsEc2Regions

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_aws_ec2_instance_types

Code samples

# You can also use wget
curl -X GET /bk/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

Name	In	Type	Required	Description
region	path	string	true	ID of group

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Settings details	AwsEc2InstanceTypes

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_azure_locations

Code samples

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

GET /azure-locations

Get settings

Get settings details

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Settings details	AzureLocations

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_azure_vm_sizes

Code samples

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

GET /azure-vm-sizes/{location}

Get settings

Get settings details

Parameters

Name	In	Type	Required	Description
location	path	string	true	ID of group

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Settings details	AzureVmSizes

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_settings

Code samples

# You can also use wget
curl -X GET /bk/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

Status	Meaning	Description	Schema
200	OK	Settings details	Settings

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth, None

update_settings

Code samples

# You can also use wget
curl -X PUT /bk/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

Name	In	Type	Required	Description
body	body	Settings	false	settings details

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	Settings

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_settings_working_state

Code samples

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

GET /settings/{resource}/working-state

Check if email or AWS settings are working

Check if email or AWS settings are working

Parameters

Name	In	Type	Required	Description
resource	path	string	true	ID of pet to return

Example responses

200 Response

{
  "state": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	SettingsWorkingState

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_diagnostics

Code samples

# You can also use wget
curl -X GET /bk/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

Status	Meaning	Description	Schema
200	OK	Successfully	Diagnostics

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_tools

Code samples

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

GET /tools

List tools

List tools

Parameters

Name	In	Type	Required	Description
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)
sort_field	query	string	false	none
sort_dir	query	string	false	none

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	Tools

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_or_update_tool

Code samples

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

POST /tools

Create or update a tool

Create a new tool or update existing version

Body parameter

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

Parameters

Name	In	Type	Required	Description
body	body	Tool	false	group

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created group	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

delete_tool

Code samples

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

DELETE /tools/{tool_id}

Delete tool

List tools

Parameters

Name	In	Type	Required	Description
tool_id	path	integer(int32)	true	ID of tool

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	Tools

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_tool_versions

Code samples

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

GET /tools/{name}

List tools

List tools

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of tool
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)
sort_field	query	string	false	none
sort_dir	query	string	false	none

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	Tools

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

upload_new_or_overwrite_tool

Code samples

# You can also use wget
curl -X POST /bk/api/tools/{name}/zip \
  -H 'Content-Type: multipart/form-data' \
  -H 'Authorization: Bearer {access-token}'

POST /tools/{name}/zip

Upload new tool or existing one

Upload code of a tool and create new one or overwrite existing version

Body parameter

meta:
  id: 0
  name: string
file: string

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of tool
body	body	object	false	none
» meta	body	Tool	false	none
»» id	body	integer(int64)	false	none
»» name	body	string	false	none
» file	body	string(binary)	false	none

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created group	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_rq_entry

Code samples

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

POST /rq/queue

Create new entry in RQ

Create new entry in RQ

Body parameter

{
  "func_name": "string",
  "args": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	RQEntry	false	RQ Entry

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created group	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Users

login

Code samples

# You can also use wget
curl -X POST /bk/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",
  "method": "string",
  "oidc_provider": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	project
» user	body	string	false	none
» password	body	string	false	none
» method	body	string	false	none
» oidc_provider	body	string	false	none

Example responses

201 Response

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

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created session.	Session

This operation does not require authentication

get_session

Code samples

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

GET /sessions/{session_token}

Get session data

Get user session data

Parameters

Name	In	Type	Required	Description
session_token	path	string	true	session token

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successfully created session.	Session

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

logout

Code samples

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

DELETE /sessions/{session_token}

Logout

Logut

Parameters

Name	In	Type	Required	Description
session_token	path	string	true	session token

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully deleted session	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_users

Code samples

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

GET /users

List users

List users

Parameters

Name	In	Type	Required	Description
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)
sort_field	query	string	false	none
sort_dir	query	string	false	none

Example responses

200 Response

{
  "items": [
    {
      "id": 0,
      "name": "string",
      "password": "string",
      "enabled": true,
      "email": "string",
      "superadmin": true
    }
  ],
  "total": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	Users

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_user

Code samples

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

POST /users

Create a user

Create a new user

Body parameter

{
  "id": 0,
  "name": "string",
  "password": "string",
  "enabled": true,
  "email": "string",
  "superadmin": true
}

Parameters

Name	In	Type	Required	Description
body	body	User	false	group

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created user	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_user

Code samples

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

GET /users/{user_id}

Get user details

Get user details

Parameters

Name	In	Type	Required	Description
user_id	path	integer(int32)	true	ID of user

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "password": "string",
  "enabled": true,
  "email": "string",
  "superadmin": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	User

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

change_user_details

Code samples

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

PATCH /users/{user_id}

Change user details

Change user details

Body parameter

{
  "id": 0,
  "name": "string",
  "password": "string",
  "enabled": true,
  "email": "string",
  "superadmin": true
}

Parameters

Name	In	Type	Required	Description
user_id	path	integer(int64)	true	ID of user
body	body	User	false	secret

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

change_password

Code samples

# You can also use wget
curl -X PUT /bk/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

Name	In	Type	Required	Description
user_id	path	integer(int64)	true	ID of user
body	body	UserPassword	false	secret

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Execution

get_flows

Code samples

# You can also use wget
curl -X GET /bk/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

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID of pet to return
kind	path	string	true	ID of pet to return
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)
middle	query	integer(int32)	false	Middle

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
        }
      },
      "report_entries": [
        {
          "name": "string",
          "url": "string"
        }
      ]
    }
  ],
  "total": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Flows
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_flow

Code samples

# You can also use wget
curl -X POST /bk/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
    }
  },
  "report_entries": [
    {
      "name": "string",
      "url": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
branch_id	path	integer(int64)	true	ID of pet to return
kind	path	string	true	ID of pet to return
body	body	Flow	false	flow

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_flow

Code samples

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

GET /flows/{flow_id}

List all results

Parameters

Name	In	Type	Required	Description
flow_id	path	integer(int64)	true	ID 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
    }
  },
  "report_entries": [
    {
      "name": "string",
      "url": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Flow
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_flow_runs

Code samples

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

GET /flows/{flow_id}/runs

List all results

Parameters

Name	In	Type	Required	Description
flow_id	path	integer(int64)	true	ID 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,
      "flow_kind": "string",
      "flow_label": "string",
      "stage_id": 0,
      "stage_name": "string",
      "args": {},
      "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,
      "report_entries": [
        {
          "name": "string",
          "url": "string"
        }
      ],
      "fix_cnt": 0,
      "regr_cnt": 0,
      "repo_data": {},
      "reason": "string"
    }
  ],
  "total": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Runs
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_run

Code samples

# You can also use wget
curl -X POST /bk/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,
  "flow_kind": "string",
  "flow_label": "string",
  "stage_id": 0,
  "stage_name": "string",
  "args": {},
  "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,
  "report_entries": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "fix_cnt": 0,
  "regr_cnt": 0,
  "repo_data": {},
  "reason": "string"
}

Parameters

Name	In	Type	Required	Description
flow_id	path	integer(int64)	true	ID of pet to return
body	body	Run	false	run

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_flow_artifacts

Code samples

# You can also use wget
curl -X GET /bk/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

Name	In	Type	Required	Description
flow_id	path	integer(int64)	true	ID of pet to return

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Artifacts
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_runs

Code samples

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

GET /stages/{stage_id}/runs

List all runs

Parameters

Name	In	Type	Required	Description
stage_id	path	integer(int64)	true	ID of pet to return
limit	query	integer(int32)	false	How 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,
      "flow_kind": "string",
      "flow_label": "string",
      "stage_id": 0,
      "stage_name": "string",
      "args": {},
      "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,
      "report_entries": [
        {
          "name": "string",
          "url": "string"
        }
      ],
      "fix_cnt": 0,
      "regr_cnt": 0,
      "repo_data": {},
      "reason": "string"
    }
  ],
  "total": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Runs
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_run_jobs

Code samples

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

GET /runs/{run_id}/jobs

List jobs

Parameters

Name	In	Type	Required	Description
run_id	path	integer(int64)	true	ID of pet to return
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)
include_covered	query	boolean	false	Include 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

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Jobs
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_run_issues

Code samples

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

GET /runs/{run_id}/issues

List run issues

Parameters

Name	In	Type	Required	Description
run_id	path	integer(int64)	true	ID of pet to return
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)
issue_types	query	array[integer]	false	none
location	query	string	false	none
message	query	string	false	none
symbol	query	string	false	none
min_age	query	integer	false	none
max_age	query	integer	false	none
job	query	string	false	none

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Issues
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_run_artifacts

Code samples

# You can also use wget
curl -X GET /bk/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

Name	In	Type	Required	Description
run_id	path	integer(int64)	true	ID of pet to return
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How 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

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Artifacts
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_run

Code samples

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

GET /runs/{run_id}

List all results

Parameters

Name	In	Type	Required	Description
run_id	path	integer(int64)	true	ID 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,
  "flow_kind": "string",
  "flow_label": "string",
  "stage_id": 0,
  "stage_name": "string",
  "args": {},
  "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,
  "report_entries": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "fix_cnt": 0,
  "regr_cnt": 0,
  "repo_data": {},
  "reason": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Run
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

run_run_jobs

Code samples

# You can also use wget
curl -X PUT /bk/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

Name	In	Type	Required	Description
run_id	path	integer(int64)	true	ID 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,
  "flow_kind": "string",
  "flow_label": "string",
  "stage_id": 0,
  "stage_name": "string",
  "args": {},
  "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,
  "report_entries": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "fix_cnt": 0,
  "regr_cnt": 0,
  "repo_data": {},
  "reason": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Run
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

force_run_analysis

Code samples

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

POST /runs/{run_id}

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

Parameters

Name	In	Type	Required	Description
run_id	path	integer(int64)	true	ID 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,
  "flow_kind": "string",
  "flow_label": "string",
  "stage_id": 0,
  "stage_name": "string",
  "args": {},
  "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,
  "report_entries": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "fix_cnt": 0,
  "regr_cnt": 0,
  "repo_data": {},
  "reason": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Run
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

cancel_run

Code samples

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

DELETE /runs/{run_id}

Cancel a run

Cancel a run

Parameters

Name	In	Type	Required	Description
run_id	path	integer(int64)	true	ID of run

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully deleted job	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_job

Code samples

# You can also use wget
curl -X POST /bk/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

Name	In	Type	Required	Description
body	body	object	false	Job to create
» run	body	integer	true	none

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created run	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_job

Code samples

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

GET /jobs/{job_id}

Get job details

Parameters

Name	In	Type	Required	Description
job_id	path	integer(int64)	true	ID of a job

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

Status	Meaning	Description	Schema
200	OK	A job	Job
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

job_rerun

Code samples

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

PUT /jobs/{job_id}

Rerun a job

Parameters

Name	In	Type	Required	Description
job_id	path	integer(int64)	true	ID 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

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Job
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

delete_job

Code samples

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

DELETE /jobs/{job_id}

Cancel a job

Cancel a job

Parameters

Name	In	Type	Required	Description
job_id	path	integer(int64)	true	ID of job

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successfully deleted job	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_job_logs

Code samples

# You can also use wget
curl -X GET /bk/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

Name	In	Type	Required	Description
job_id	path	integer	true	ID of pet to return
start	query	integer	true	ID of pet to return
limit	query	integer	true	ID of pet to return
order	query	string	false	ID of pet to return
internals	query	boolean	false	ID of pet to return
filters	query	string	false	ID 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

Status	Meaning	Description	Schema
200	OK	A paged array of logs	Logs
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_step_logs

Code samples

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

GET /jobs/{job_id}/{step_idx}/logs

Get a step logs

Get a step logs

Parameters

Name	In	Type	Required	Description
job_id	path	integer	true	ID of pet to return
step_idx	path	integer	true	ID of pet to return
start	query	integer	true	ID of pet to return
limit	query	integer	true	ID of pet to return
order	query	string	false	ID of pet to return
filters	query	string	false	ID 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

Status	Meaning	Description	Schema
200	OK	A paged array of logs	Logs
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_logs

Code samples

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

GET /logs

Get logs

Get logs

Parameters

Name	In	Type	Required	Description
branch_id	query	integer(int64)	false	ID of branch
flow_kind	query	integer(int64)	false	Flow kind, 0 - CI, 1 - Dev
flow_id	query	integer(int64)	false	ID of flow
run_id	query	integer(int64)	false	ID of run
job_id	query	integer(int64)	false	ID of job
step_idx	query	integer	false	ID of pet to return
agent_id	query	integer(int64)	false	ID of agent
services	query	array[string]	false	List of services
level	query	string	false	log level
start	query	integer	true	Start
limit	query	integer	true	Limit
order	query	string	false	Order, desc or asc

Example responses

200 Response

{
  "items": [
    {
      "time": "string",
      "message": "string",
      "service": "string",
      "host": "string",
      "path": "string",
      "lineno": "string",
      "level": "string",
      "branch": "string",
      "flow_kind": "string",
      "flow": "string",
      "run": "string",
      "job": "string",
      "tool": "string",
      "step": "string",
      "agent": "string"
    }
  ],
  "total": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of logs	ServicesLogs
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_agent_jobs

Code samples

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

GET /agents/{agent_id}/jobs

List jobs executed by given agent

Parameters

Name	In	Type	Required	Description
agent_id	path	integer(int64)	true	ID of agent
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)

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

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Jobs
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_user_data

Code samples

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

GET /user_data

Get user data.

Get user data.

Parameters

Name	In	Type	Required	Description
scope	query	string	false	Scope of user data
entity_id	query	integer(int32)	false	Entity ID

Example responses

200 Response

{
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» data	string	false	none	none

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Results

get_flow_analysis

Code samples

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

GET /flows/{flow_id}/analysis

Results analysis of given flow

Parameters

Name	In	Type	Required	Description
flow_id	path	integer(int64)	true	ID of pet to return

Example responses

200 Response

{
  "stats": {},
  "recs_map": {},
  "total_tests": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	FlowAnalysis
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_branch_history

Code samples

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

GET /flows/{flow_id}/history

Results history of till given flow

Parameters

Name	In	Type	Required	Description
flow_id	path	integer(int64)	true	ID of pet to return
limit	query	integer(int64)	true	number of flows to return

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	An array of flows	BranchHistory
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_run_results

Code samples

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

GET /runs/{run_id}/results

List all results

Parameters

Name	In	Type	Required	Description
run_id	path	integer(int64)	true	ID of pet to return
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)
sort_field	query	string	false	none
sort_dir	query	string	false	none
statuses	query	array[integer]	false	none
changes	query	array[integer]	false	none
min_age	query	integer	false	none
max_age	query	integer	false	none
min_instability	query	integer	false	none
max_instability	query	integer	false	none
test_case_text	query	string	false	none
job	query	string	false	none
systems	query	array[integer]	false	none
groups	query	array[integer]	false	none

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Results
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_result

Code samples

# You can also use wget
curl -X GET /bk/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

Name	In	Type	Required	Description
test_case_result_id	path	integer(int64)	true	ID of pet to return

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Result
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

get_result_history

Code samples

# You can also use wget
curl -X GET /bk/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

Name	In	Type	Required	Description
test_case_result_id	path	integer(int64)	true	ID of pet to return
start	query	integer(int32)	false	How many items to return at one time (max 100)
limit	query	integer(int32)	false	How many items to return at one time (max 100)

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of runs	Results
default	Default	unexpected error	ApiError

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

create_or_update_test_case_comment

Code samples

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

POST /test_case_results/{test_case_result_id}/comment

Create or update a comment to the result

Create or update a comment to the result

Body parameter

{
  "text": "string",
  "author": "string",
  "state": 0
}

Parameters

Name	In	Type	Required	Description
test_case_result_id	path	integer(int64)	true	ID of test case result
body	body	object	false	Comment to create
» text	body	string	false	none
» author	body	string	false	none
» state	body	integer(int64)	false	none

Example responses

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created comment	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Schemas

Session

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
token	string	false	none	none

Users

{
  "items": [
    {
      "id": 0,
      "name": "string",
      "password": "string",
      "enabled": true,
      "email": "string",
      "superadmin": true
    }
  ],
  "total": 0
}

Properties

Name	Type	Required	Restrictions	Description
items	[User]	false	none	none
total	integer(int64)	false	none	none

User

{
  "id": 0,
  "name": "string",
  "password": "string",
  "enabled": true,
  "email": "string",
  "superadmin": true
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none
password	string	false	none	none
enabled	boolean	false	none	none
email	string	false	none	none
superadmin	boolean	false	none	none

UserPassword

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

Properties

Name	Type	Required	Restrictions	Description
password_old	string	false	none	none
password_new	string	false	none	none

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
    }
  },
  "report_entries": [
    {
      "name": "string",
      "url": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
label	string	false	none	none
branch_id	integer(int64)	false	none	none
created	string(date-time)	false	none	none
project_id	integer(int64)	false	none	none
project_name	string	false	none	none
base_branch_name	string	false	none	none
branch_name	string	false	none	none
runs	object	false	none	none
stages	[Stage]	false	none	none
args	object	false	none	none
kind	string	false	none	none
artifacts	object	false	none	none
» public	object	false	none	none
»» count	integer(int64)	false	none	none
report_entries	[ReportEntry]	false	none	none

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
        }
      },
      "report_entries": [
        {
          "name": "string",
          "url": "string"
        }
      ]
    }
  ],
  "total": 0
}

Properties

Name	Type	Required	Restrictions	Description
items	[Flow]	false	none	none
total	integer(int64)	false	none	none

Run

{
  "id": 0,
  "label": "string",
  "project_id": 0,
  "project_name": "string",
  "branch_id": 0,
  "branch_name": "string",
  "flow_id": 0,
  "flow_kind": "string",
  "flow_label": "string",
  "stage_id": 0,
  "stage_name": "string",
  "args": {},
  "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,
  "report_entries": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "fix_cnt": 0,
  "regr_cnt": 0,
  "repo_data": {},
  "reason": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
label	string	false	none	none
project_id	integer(int64)	false	none	none
project_name	string	false	none	none
branch_id	integer(int64)	false	none	none
branch_name	string	false	none	none
flow_id	integer(int64)	false	none	none
flow_kind	string	false	none	none
flow_label	string	false	none	none
stage_id	integer(int64)	false	none	none
stage_name	string	false	none	none
args	object	false	none	none
created	string(date-time)	false	none	none
started	string(date-time)	false	none	none
duration	string	false	none	none
state	string	false	none	none
jobs_error	integer	false	none	none
jobs_rerun	integer	false	none	none
jobs_waiting	integer	false	none	none
jobs_executing	integer	false	none	none
jobs_processing	integer	false	none	none
jobs_total	integer	false	none	none
tests_not_run	integer	false	none	none
tests_passed	integer	false	none	none
tests_total	integer	false	none	none
issues_total	integer	false	none	none
issues_new	integer	false	none	none
artifacts_total	integer	false	none	none
report_entries	[ReportEntry]	false	none	none
fix_cnt	integer	false	none	none
regr_cnt	integer	false	none	none
repo_data	object	false	none	none
reason	string	false	none	none

Runs

{
  "items": [
    {
      "id": 0,
      "label": "string",
      "project_id": 0,
      "project_name": "string",
      "branch_id": 0,
      "branch_name": "string",
      "flow_id": 0,
      "flow_kind": "string",
      "flow_label": "string",
      "stage_id": 0,
      "stage_name": "string",
      "args": {},
      "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,
      "report_entries": [
        {
          "name": "string",
          "url": "string"
        }
      ],
      "fix_cnt": 0,
      "regr_cnt": 0,
      "repo_data": {},
      "reason": "string"
    }
  ],
  "total": 0
}

Properties

Name	Type	Required	Restrictions	Description
items	[Run]	false	none	none
total	integer(int64)	false	none	none

Result

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	true	none	none
job_id	integer(int64)	true	none	none
values	object	false	none	none

Results

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

Properties

Name	Type	Required	Restrictions	Description
items	[Result]	false	none	none
total	integer(int64)	false	none	none

Issue

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	true	none	none
job_id	integer(int64)	true	none	none
job_name	string	false	none	none

Issues

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

Properties

Name	Type	Required	Restrictions	Description
items	[Issue]	false	none	none
total	integer(int64)	false	none	none

Artifact

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
flow_id	integer(int64)	false	none	none
run_id	integer(int64)	false	none	none
size	integer	false	none	none
path	string	false	none	none

Artifacts

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

Properties

Name	Type	Required	Restrictions	Description
items	[Artifact]	false	none	none
total	integer(int64)	false	none	none

FlowAnalysis

{
  "stats": {},
  "recs_map": {},
  "total_tests": 0
}

Properties

Name	Type	Required	Restrictions	Description
stats	object	false	none	none
recs_map	object	false	none	none
total_tests	integer	false	none	none

BranchHistory

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

Properties

Name	Type	Required	Restrictions	Description
items	[object]	false	none	none
total	integer	false	none	none

ReportEntry

{
  "name": "string",
  "url": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
url	string	false	none	none

Log

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

Properties

Name	Type	Required	Restrictions	Description
time	string	false	none	none
message	string	false	none	none
service	string	false	none	none
host	string	false	none	none
level	string	false	none	none
job	integer	false	none	none
tool	string	false	none	none
step	integer	false	none	none

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

Name	Type	Required	Restrictions	Description
items	[Log]	false	none	none
total	integer(int64)	false	none	none
bookmarks	object	false	none	none
» first	string	false	none	none
» last	string	false	none	none
job	Job	false	none	none

RQJobNames

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

Properties

Name	Type	Required	Restrictions	Description
items	[object]	false	none	none
» time	string	false	none	none
» name	string	false	none	none
» lines	integer(int64)	false	none	none

ServicesLog

{
  "time": "string",
  "message": "string",
  "service": "string",
  "host": "string",
  "path": "string",
  "lineno": "string",
  "level": "string",
  "branch": "string",
  "flow_kind": "string",
  "flow": "string",
  "run": "string",
  "job": "string",
  "tool": "string",
  "step": "string",
  "agent": "string"
}

Properties

Name	Type	Required	Restrictions	Description
time	string	false	none	none
message	string	false	none	none
service	string	false	none	none
host	string	false	none	none
path	string	false	none	none
lineno	string	false	none	none
level	string	false	none	none
branch	string	false	none	none
flow_kind	string	false	none	none
flow	string	false	none	none
run	string	false	none	none
job	string	false	none	none
tool	string	false	none	none
step	string	false	none	none
agent	string	false	none	none

ServicesLogs

{
  "items": [
    {
      "time": "string",
      "message": "string",
      "service": "string",
      "host": "string",
      "path": "string",
      "lineno": "string",
      "level": "string",
      "branch": "string",
      "flow_kind": "string",
      "flow": "string",
      "run": "string",
      "job": "string",
      "tool": "string",
      "step": "string",
      "agent": "string"
    }
  ],
  "total": 0
}

Properties

Name	Type	Required	Restrictions	Description
items	[ServicesLog]	false	none	none
total	integer(int64)	false	none	none

LiveData

{
  "error_logs_count": 0,
  "authorized_agents": 0,
  "non_authorized_agents": 0
}

Properties

Name	Type	Required	Restrictions	Description
error_logs_count	integer(int64)	false	none	none
authorized_agents	integer(int64)	false	none	none
non_authorized_agents	integer(int64)	false	none	none

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

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
created	string(date-time)	false	none	none
started	string(date-time)	false	none	none
finished	string(date-time)	false	none	none
completed	string(date-time)	false	none	none
duration	string	false	none	none
timeout	integer	false	none	none
name	string	false	none	none
state	integer	false	none	none
completion_status	integer	false	none	none
notes	string	false	none	none
run_id	integer	false	none	none
steps	[object]	false	none	none
agents_group_id	integer	false	none	none
agents_group_name	string	false	none	none
agent_id	integer	false	none	none
agent_name	string	false	none	none
executor	string	false	none	none
system	string	false	none	none

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

Name	Type	Required	Restrictions	Description
items	[Job]	false	none	none
total	integer(int64)	false	none	none

Project

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none
webhooks	object	false	none	none
branches	[object]	false	none	none

Projects

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

Properties

Name	Type	Required	Restrictions	Description
items	[Project]	false	none	none
total	integer(int64)	false	none	none

Secret

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none
project_id	integer(int64)	false	none	none
project_name	string	false	none	none
kind	string	false	none	none
username	string	false	none	none
key	string	false	none	none

Branch

{
  "id": 0,
  "created": "2019-08-24T14:15:22Z",
  "name": "string",
  "branch_name": "string",
  "project_id": 0,
  "project_name": "string",
  "forking_model": "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": {},
  "retention_policy": {
    "ci_logs": 0,
    "dev_logs": 0,
    "ci_artifacts": 0,
    "dev_artifacts": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
created	string(date-time)	false	none	none
name	string	false	none	none
branch_name	string	false	none	none
project_id	integer(int64)	false	none	none
project_name	string	false	none	none
forking_model	string	false	none	none
stages	[Stage]	false	none	none
flows	object	false	none	none
retention_policy	RetentionPolicy	false	none	none

BranchSequence

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
branch_name	string	false	none	none
branch_id	integer(int64)	false	none	none
stage_name	string	false	none	none
stage_id	integer(int64)	false	none	none
kind	integer(int64)	false	none	none
value	integer(int64)	false	none	none

BranchSequences

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

Properties

Name	Type	Required	Restrictions	Description
items	[BranchSequence]	false	none	none
total	integer(int64)	false	none	none

BranchStats

{
  "id": 0,
  "ci": {
    "flows_total": 0,
    "flows_last_week": 0,
    "flows_last_month": 0,
    "avg_duration_last_month": 0,
    "avg_duration_last_week": 0,
    "durations": [
      {
        "flow_label": "string",
        "duration": 0
      }
    ]
  },
  "dev": {
    "flows_total": 0,
    "flows_last_week": 0,
    "flows_last_month": 0,
    "avg_duration_last_month": 0,
    "avg_duration_last_week": 0,
    "durations": [
      {
        "flow_label": "string",
        "duration": 0
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
ci	BranchStatsByKind	false	none	none
dev	BranchStatsByKind	false	none	none

BranchStatsByKind

{
  "flows_total": 0,
  "flows_last_week": 0,
  "flows_last_month": 0,
  "avg_duration_last_month": 0,
  "avg_duration_last_week": 0,
  "durations": [
    {
      "flow_label": "string",
      "duration": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
flows_total	integer(int64)	false	none	none
flows_last_week	integer(int64)	false	none	none
flows_last_month	integer(int64)	false	none	none
avg_duration_last_month	integer(int64)	false	none	none
avg_duration_last_week	integer(int64)	false	none	none
durations	[object]	false	none	none
» flow_label	string	false	none	none
» duration	integer(int64)	false	none	none

RetentionPolicy

{
  "ci_logs": 0,
  "dev_logs": 0,
  "ci_artifacts": 0,
  "dev_artifacts": 0
}

Properties

Name	Type	Required	Restrictions	Description
ci_logs	integer(int64)	false	none	none
dev_logs	integer(int64)	false	none	none
ci_artifacts	integer(int64)	false	none	none
dev_artifacts	integer(int64)	false	none	none

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

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	true	none	none
branch_id	integer(int64)	false	none	none
branch_name	string	false	none	none
schema	object	false	none	none
» parent	string	false	none	none
» triggers	object	false	none	none
»» parent	boolean	false	none	none
» parameters	[object]	false	none	none
»» name	string	false	none	none
»» default	string	false	none	none
schema_code	string	false	none	none
enabled	boolean	false	none	none

StageSchemaJson

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

Properties

Name	Type	Required	Restrictions	Description
stage_id	integer(int64)	false	none	none
schema	string	false	none	none
error	string	false	none	none

StageSchemaCode

{
  "schema_code": "string"
}

Properties

Name	Type	Required	Restrictions	Description
schema_code	string	true	none	none

StageSchedule

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

Properties

Name	Type	Required	Restrictions	Description
schedules	[object]	false	none	none
» name	string	false	none	none
» job_id	string	false	none	none
» next_run_time	string	false	none	none

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

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none
address	string	false	none	none
authorized	boolean	false	none	none
ip_address	string	false	none	none
state	integer	false	none	none
disabled	boolean	false	none	none
groups	[object]	false	none	none
job	object	false	none	none
last_seen	string(date-time)	false	none	none
host_info	object	false	none	none
user_attrs	object	false	none	none

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

Name	Type	Required	Restrictions	Description
items	[Agent]	false	none	none
total	integer(int64)	false	none	none

Group

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none
project_name	string	false	none	none
project_id	integer	false	none	none
agents_count	integer	false	none	none

Groups

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

Properties

Name	Type	Required	Restrictions	Description
items	[Group]	false	none	none
total	integer(int64)	false	none	none

System

{
  "id": 0,
  "name": "string",
  "executor": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none
executor	string	false	none	none

Systems

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

Properties

Name	Type	Required	Restrictions	Description
items	[System]	false	none	none
total	integer(int64)	false	none	none

AwsEc2Regions

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

Properties

Name	Type	Required	Restrictions	Description
items	[object]	false	none	none
» Endpoint	string	false	none	none
» RegionName	string	false	none	none
» OptInStatus	string	false	none	none
total	integer(int64)	false	none	none

AwsEc2InstanceTypes

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

Properties

Name	Type	Required	Restrictions	Description
items	[object]	false	none	none
» InstanceType	string	false	none	none
total	integer(int64)	false	none	none

AzureLocations

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

Properties

Name	Type	Required	Restrictions	Description
items	[string]	false	none	none
total	integer(int64)	false	none	none

AzureVmSizes

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

Properties

Name	Type	Required	Restrictions	Description
items	[string]	false	none	none
total	integer(int64)	false	none	none

Settings

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

Properties

Name	Type	Required	Restrictions	Description
general	object	false	none	none
notification	object	false	none	none
monitoring	object	false	none	none

SettingsWorkingState

{
  "state": "string"
}

Properties

Name	Type	Required	Restrictions	Description
state	string	false	none	none

Diagnostics

{}

Properties

None

Tools

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

Properties

Name	Type	Required	Restrictions	Description
items	[Tool]	false	none	none
total	integer(int64)	false	none	none

Tool

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none

RQEntry

{
  "func_name": "string",
  "args": "string"
}

Properties

Name	Type	Required	Restrictions	Description
func_name	string	false	none	none
args	string	false	none	none

ServerVersion

{
  "version": "string"
}

Properties

Name	Type	Required	Restrictions	Description
version	string	false	none	none

ApiError

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

Properties

Name	Type	Required	Restrictions	Description
code	integer(int32)	true	none	none
message	string	true	none	none