Create a variable for a pipeline schedule

POST

/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables

• GitLab REST API

Creates a variable for a pipeline schedule.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project

Example

18

pipeline_schedule_id

required

integer

The pipeline schedule id

Example

13

Request Body^required

Media typeapplication/json

object

key

required

The key of the variable

string

nullable

Example

NEW_VARIABLE

value

required

The value of the variable

string

nullable

Example

new value

variable_type

The type of variable, must be one of env_var or file. Defaults to env_var

string

nullable

Allowed values: env_var file

Responses

201

Created

Media typeapplication/json

object

variable_type

string

key

string

value

string

hidden

boolean

protected

boolean

masked

boolean

raw

boolean

environment_scope

string

description

string

Example

{
  "variable_type": "env_var",
  "key": "TEST_VARIABLE_1",
  "value": "TEST_1",
  "environment_scope": "*",
  "description": "This variable is being used for ..."
}

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found