logo

Trigger Keys

Endpoints for managing the trigger keys used to kick off a pipeline run.

List Trigger Keys

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

query Parameters
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of Trigger Keys.

default

General error response from the platform

get/v1/pipelines/{pipelineId}/keys
Response samples
application/json
{
  • "data": [
    ]
}

Create Trigger Key

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

Request Body schema: application/json

Parameters for creating a new Pipeline Trigger Key.

name
string

A name for the Trigger Key.

ips
Array of strings

An array of ips this Trigger Key is usable from.

Responses
201

Returns a Trigger Key.

default

General error response from the platform

post/v1/pipelines/{pipelineId}/keys
Request samples
application/json
{
  • "name": "string",
  • "ips": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}

Get Trigger Key

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

triggerKeyId
required
string

The ID of the Trigger Key.

Responses
200

Returns a Trigger Key.

default

General error response from the platform

get/v1/pipelines/{pipelineId}/keys/{triggerKeyId}
Response samples
application/json
{
  • "data": {
    }
}

Delete Trigger Key

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

triggerKeyId
required
string

The ID of the Trigger Key.

Responses
202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/pipelines/{pipelineId}/keys/{triggerKeyId}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Networks