Stages

APIs to modify Stage information

Get all Pipeline stages

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

Responses
200

Pipelines stages response

get/v0/pipelines/{pipeline_id}/stages/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Create a Pipeline stage

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

Request Body schema: application/json
name
required
string
description
string
timeout_seconds
number <int32>
Responses
200

Pipelines stages create response

400

Stage create error

post/v0/pipelines/{pipeline_id}/stages/
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "timeout_seconds": 0
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get a Pipeline Stage

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

stage_id
required
string

ID of the Stage

Responses
200

Pipelines stage get response

get/v0/pipelines/{pipeline_id}/stages/{stage_id}/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Update a Pipeline Stage

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

stage_id
required
string

ID of the Stage

Request Body schema: application/json
name
string
description
string
timeout_seconds
number <int32>
Responses
200

Updated Stage Information

400

Stage update error

401

Stage update error

put/v0/pipelines/{pipeline_id}/stages/{stage_id}/
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "timeout_seconds": 0
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Delete a pipeline stage

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

stage_id
required
string

ID of the Stage

Responses
200

Deleted Stage Information

401

Stage delete error

delete/v0/pipelines/{pipeline_id}/stages/{stage_id}/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get all Target Lists attached to the Stage

Request
Security:
path Parameters
stage_id
required
string <uuid>

ID of the Stage

query Parameters
type
string
Enum: "groups" "devices" "collections"
Responses
200

All Targets Lists attached to the Stage

401

Target List get error

get/v0/stages/{stage_id}/targetlists/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Attach the Target List to the Stage

Request
Security:
path Parameters
stage_id
required
string

ID of the Stage

Request Body schema: application/json
target_list_id
required
string <uuid>
Responses
200

Attach target list to a Stage

401

Target list attach error

post/v0/stages/{stage_id}/targetlists/
Request samples
application/json
{
  • "target_list_id": "e020bfe9-7c71-4403-800b-700dad22bfd2"
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Detach the Target List from the Stage

Request
Security:
path Parameters
stage_id
required
string

ID of the Stage

targetlist_id
required
string

ID of the Target List

Responses
200

Detach target list from stage

401

Target list attach error

delete/v0/stages/{stage_id}/targetlists/{targetlist_id}/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}