ProjectCreateEnvVarRequest
{
"type": "object",
"title": "EnvironmentVariable",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"example": "foo",
"description": "The name of the environment variable."
},
"value": {
"type": "string",
"example": "xxxx1234",
"description": "The value of the environment variable."
}
},
"description": "An environment variable request requires a name and a value"
}
ProjectCreateEnvVarResponse
{
"type": "object",
"title": "EnvironmentVariable",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"example": "foo",
"description": "The name of the environment variable."
},
"value": {
"type": "string",
"example": "xxxx1234",
"description": "The value of the environment variable."
},
"created-at": {
"example": "#joda/inst 2023-04-14T21:20:14+0000",
"x-nullable": true,
"description": "The creation timestamp of the environment variable."
}
},
"description": "An environment variable is a map containing a value and an optional timestamp."
}
ProjectCreateEnvVardefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProjectCreateProjectDefaultSettings403Response
{
"properties": {
"message": {
"type": "string",
"default": "Permission denied."
}
},
"additionalProperties": false
}
ProjectCreateProjectDefaultSettings404Response
{
"properties": {
"message": {
"type": "string"
}
},
"additionalProperties": false
}
ProjectCreateProjectDefaultSettings405Response
{
"properties": {
"message": {
"type": "string",
"default": "Create projects using the API is currently supported for classic Github OAuth and Bitbucket projects only."
}
},
"additionalProperties": false
}
ProjectCreateProjectDefaultSettingsResponse
{
"properties": {
"message": {
"type": "string",
"default": "Unexpected request body provided."
}
},
"additionalProperties": false
}
ProjectDeleteCheckoutKeyByFingerprintResponse
{
"type": "object",
"title": "MessageResponse",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"description": "A human-readable message"
}
},
"description": "message response"
}
ProjectDeleteCheckoutKeyByFingerprintdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProjectDeleteEnvironmentVariableResponse
{
"type": "object",
"title": "MessageResponse",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"description": "A human-readable message"
}
},
"description": "message response"
}
ProjectDeleteEnvironmentVariabledefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProjectGetBySlugResponse
{
"type": "object",
"title": "Project",
"required": [
"slug",
"name",
"id",
"organization_name",
"organization_slug",
"organization_id",
"vcs_info"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "api-preview-docs",
"description": "The name of the project"
},
"slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
},
"vcs_info": {
"type": "object",
"required": [
"vcs_url",
"provider",
"default_branch"
],
"properties": {
"vcs_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL to the repository hosting the project's code"
},
"provider": {
"enum": [
"Bitbucket",
"CircleCI",
"GitHub"
],
"type": "string",
"description": "The VCS provider"
},
"default_branch": {
"type": "string",
"example": "master"
}
},
"description": "Information about the VCS that hosts the project source code."
},
"organization_id": {
"type": "string",
"format": "uuid",
"example": "CircleCI-Public",
"description": "The id of the organization the project belongs to"
},
"organization_name": {
"type": "string",
"example": "CircleCI-Public",
"description": "The name of the organization the project belongs to"
},
"organization_slug": {
"type": "string",
"example": "CircleCI-Public",
"description": "The slug of the organization the project belongs to"
}
},
"description": "NOTE: The definition of Project is subject to change."
}
ProjectGetBySlugdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProjectGetCheckoutKeyByFingerprintResponse
{
"type": "object",
"title": "CheckoutKey",
"required": [
"public-key",
"type",
"fingerprint",
"preferred",
"created-at"
],
"properties": {
"type": {
"enum": [
"deploy-key",
"github-user-key"
],
"type": "string",
"title": "CheckoutKeyType",
"example": "deploy-key",
"description": "The type of checkout key. This may be either `deploy-key` or `github-user-key`."
},
"preferred": {
"type": "boolean",
"example": true,
"description": "A boolean value that indicates if this key is preferred."
},
"created-at": {
"type": "string",
"format": "date-time",
"example": "2015-09-21T17:29:21.042Z",
"description": "The date and time the checkout key was created."
},
"public-key": {
"type": "string",
"example": "ssh-rsa ...",
"description": "A public SSH key."
},
"fingerprint": {
"type": "string",
"example": "c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f",
"description": "An SSH key fingerprint."
}
},
"description": "A checkout key"
}
ProjectGetCheckoutKeyByFingerprintdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProjectGetMaskedEnvVarResponse
{
"type": "object",
"title": "EnvironmentVariable",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"example": "foo",
"description": "The name of the environment variable."
},
"value": {
"type": "string",
"example": "xxxx1234",
"description": "The value of the environment variable."
},
"created-at": {
"example": "#joda/inst 2023-04-14T21:20:14+0000",
"x-nullable": true,
"description": "The creation timestamp of the environment variable."
}
},
"description": "An environment variable is a map containing a value and an optional timestamp."
}
ProjectGetMaskedEnvVardefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProjectGetSettingsResponse
{
"properties": {
"message": {
"type": "string",
"default": "Project not found."
}
},
"additionalProperties": false
}
ProjectListCheckoutKeysResponse
{
"type": "object",
"title": "CheckoutKeyListResponse",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "CheckoutKey",
"required": [
"public-key",
"type",
"fingerprint",
"preferred",
"created-at"
],
"properties": {
"type": {
"enum": [
"deploy-key",
"github-user-key"
],
"type": "string",
"title": "CheckoutKeyType",
"example": "deploy-key",
"description": "The type of checkout key. This may be either `deploy-key` or `github-user-key`."
},
"preferred": {
"type": "boolean",
"example": true,
"description": "A boolean value that indicates if this key is preferred."
},
"created-at": {
"type": "string",
"format": "date-time",
"example": "2015-09-21T17:29:21.042Z",
"description": "The date and time the checkout key was created."
},
"public-key": {
"type": "string",
"example": "ssh-rsa ...",
"description": "A public SSH key."
},
"fingerprint": {
"type": "string",
"example": "c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f",
"description": "An SSH key fingerprint."
}
},
"description": "A checkout key"
}
},
"next_page_token": {
"type": "string",
"x-nullable": true,
"description": "A token to pass as a `page-token` query parameter to return the next page of results."
}
}
}
ProjectListCheckoutKeysdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProjectListEnvVarValuesResponse
{
"type": "object",
"title": "EnvironmentVariableListResponse",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "EnvironmentVariable",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"example": "foo",
"description": "The name of the environment variable."
},
"value": {
"type": "string",
"example": "xxxx1234",
"description": "The value of the environment variable."
},
"created-at": {
"example": "#joda/inst 2023-04-14T21:20:14+0000",
"x-nullable": true,
"description": "The creation timestamp of the environment variable."
}
},
"description": "An environment variable is a map containing a value and an optional timestamp."
}
},
"next_page_token": {
"type": "string",
"x-nullable": true,
"description": "A token to pass as a `page-token` query parameter to return the next page of results."
}
}
}
ProjectListEnvVarValuesdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProjectUpdateSettingsResponse
{
"properties": {
"message": {
"type": "string"
}
},
"additionalProperties": false
}
ScheduleCreateNewScheduleRequest
{
"type": "object",
"title": "CreateScheduleParameters",
"required": [
"name",
"timetable",
"attribution-actor",
"parameters"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the schedule."
},
"timetable": {
"anyOf": [
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-week"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
},
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-month"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
}
],
"description": "Timetable that specifies when a schedule triggers."
},
"parameters": {
"type": "object",
"example": {
"branch": "feature/design-new-api",
"deploy_prod": true
},
"description": "Pipeline parameters represented as key-value pairs. Must contain branch or tag.",
"additionalProperties": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"description": {
"type": "string",
"x-nullable": true,
"description": "Description of the schedule."
},
"attribution-actor": {
"enum": [
"current",
"system"
],
"type": "string",
"example": "current",
"description": "The attribution-actor of the scheduled pipeline."
}
},
"description": "The parameters for a create schedule request"
}
ScheduleCreateNewScheduleResponse
{
"type": "object",
"title": "Schedule",
"required": [
"id",
"name",
"timetable",
"description",
"project-slug",
"actor",
"created-at",
"updated-at",
"parameters"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the schedule."
},
"name": {
"type": "string",
"description": "Name of the schedule."
},
"actor": {
"type": "object",
"title": "User",
"required": [
"id",
"login",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user."
},
"name": {
"type": "string",
"description": "The name of the user."
},
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
}
},
"description": "The attribution actor who will run the scheduled pipeline."
},
"timetable": {
"anyOf": [
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-week"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
},
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-month"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
}
],
"description": "Timetable that specifies when a schedule triggers."
},
"created-at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
},
"parameters": {
"type": "object",
"example": {
"branch": "feature/design-new-api",
"deploy_prod": true
},
"description": "Pipeline parameters represented as key-value pairs. Must contain branch or tag.",
"additionalProperties": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"updated-at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was last updated."
},
"description": {
"type": "string",
"x-nullable": true,
"description": "Description of the schedule."
},
"project-slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the schedule"
}
},
"description": "A schedule response"
}
ScheduleCreateNewScheduledefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ScheduleGetAllSchedulesResponse
{
"type": "object",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Schedule",
"required": [
"id",
"name",
"timetable",
"description",
"project-slug",
"actor",
"created-at",
"updated-at",
"parameters"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the schedule."
},
"name": {
"type": "string",
"description": "Name of the schedule."
},
"actor": {
"type": "object",
"title": "User",
"required": [
"id",
"login",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user."
},
"name": {
"type": "string",
"description": "The name of the user."
},
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
}
},
"description": "The attribution actor who will run the scheduled pipeline."
},
"timetable": {
"anyOf": [
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-week"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
},
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-month"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
}
],
"description": "Timetable that specifies when a schedule triggers."
},
"created-at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
},
"parameters": {
"type": "object",
"example": {
"branch": "feature/design-new-api",
"deploy_prod": true
},
"description": "Pipeline parameters represented as key-value pairs. Must contain branch or tag.",
"additionalProperties": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"updated-at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was last updated."
},
"description": {
"type": "string",
"x-nullable": true,
"description": "Description of the schedule."
},
"project-slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the schedule"
}
},
"description": "A schedule response"
}
},
"next_page_token": {
"type": "string",
"x-nullable": true,
"description": "A token to pass as a `page-token` query parameter to return the next page of results."
}
},
"description": "A sequence of schedules"
}
ScheduleGetAllSchedulesdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ScheduleGetByIdResponse
{
"type": "object",
"title": "Schedule",
"required": [
"id",
"name",
"timetable",
"description",
"project-slug",
"actor",
"created-at",
"updated-at",
"parameters"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the schedule."
},
"name": {
"type": "string",
"description": "Name of the schedule."
},
"actor": {
"type": "object",
"title": "User",
"required": [
"id",
"login",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user."
},
"name": {
"type": "string",
"description": "The name of the user."
},
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
}
},
"description": "The attribution actor who will run the scheduled pipeline."
},
"timetable": {
"anyOf": [
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-week"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
},
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-month"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
}
],
"description": "Timetable that specifies when a schedule triggers."
},
"created-at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
},
"parameters": {
"type": "object",
"example": {
"branch": "feature/design-new-api",
"deploy_prod": true
},
"description": "Pipeline parameters represented as key-value pairs. Must contain branch or tag.",
"additionalProperties": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"updated-at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was last updated."
},
"description": {
"type": "string",
"x-nullable": true,
"description": "Description of the schedule."
},
"project-slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the schedule"
}
},
"description": "A schedule response"
}
ScheduleGetByIddefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ScheduleRemoveByIdResponse
{
"type": "object",
"title": "MessageResponse",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"description": "A human-readable message"
}
},
"description": "message response"
}
ScheduleRemoveByIddefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ScheduleUpdateScheduleRequest
{
"type": "object",
"title": "UpdateScheduleParameters",
"properties": {
"name": {
"type": "string",
"description": "Name of the schedule."
},
"timetable": {
"type": "object",
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
},
"description": "Timetable that specifies when a schedule triggers."
},
"parameters": {
"type": "object",
"example": {
"branch": "feature/design-new-api",
"deploy_prod": true
},
"description": "Pipeline parameters represented as key-value pairs. Must contain branch or tag.",
"additionalProperties": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"description": {
"type": "string",
"x-nullable": true,
"description": "Description of the schedule."
},
"attribution-actor": {
"enum": [
"current",
"system"
],
"type": "string",
"example": "current",
"description": "The attribution-actor of the scheduled pipeline."
}
},
"description": "The parameters for an update schedule request"
}
ScheduleUpdateScheduleResponse
{
"type": "object",
"title": "Schedule",
"required": [
"id",
"name",
"timetable",
"description",
"project-slug",
"actor",
"created-at",
"updated-at",
"parameters"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the schedule."
},
"name": {
"type": "string",
"description": "Name of the schedule."
},
"actor": {
"type": "object",
"title": "User",
"required": [
"id",
"login",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user."
},
"name": {
"type": "string",
"description": "The name of the user."
},
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
}
},
"description": "The attribution actor who will run the scheduled pipeline."
},
"timetable": {
"anyOf": [
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-week"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
},
{
"type": "object",
"required": [
"per-hour",
"hours-of-day",
"days-of-month"
],
"properties": {
"months": {
"type": "array",
"items": {
"enum": [
"MAR",
"NOV",
"DEC",
"JUN",
"MAY",
"OCT",
"FEB",
"APR",
"SEP",
"AUG",
"JAN",
"JUL"
],
"type": "string",
"description": "Month, in three letters format."
},
"description": "Months in which the schedule triggers."
},
"per-hour": {
"type": "integer",
"format": "integer",
"description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
},
"days-of-week": {
"type": "array",
"items": {
"enum": [
"TUE",
"SAT",
"SUN",
"MON",
"THU",
"WED",
"FRI"
],
"type": "string",
"description": "Day in a week, in three letters format"
},
"description": "Days in a week in which the schedule triggers."
},
"hours-of-day": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Hour in a day in UTC, value must be between 0 and 24"
},
"description": "Hours in a day in which the schedule triggers."
},
"days-of-month": {
"type": "array",
"items": {
"type": "integer",
"format": "integer",
"description": "Day in a month, between 1 and 31."
},
"description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
}
}
}
],
"description": "Timetable that specifies when a schedule triggers."
},
"created-at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
},
"parameters": {
"type": "object",
"example": {
"branch": "feature/design-new-api",
"deploy_prod": true
},
"description": "Pipeline parameters represented as key-value pairs. Must contain branch or tag.",
"additionalProperties": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"updated-at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was last updated."
},
"description": {
"type": "string",
"x-nullable": true,
"description": "Description of the schedule."
},
"project-slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the schedule"
}
},
"description": "A schedule response"
}
ScheduleUpdateScheduledefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
UserGetInformationResponse
{
"type": "object",
"title": "User",
"required": [
"id",
"login",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user."
},
"name": {
"type": "string",
"description": "The name of the user."
},
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
}
}
}
UserGetInformationdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
UserGetUserInformationResponse
{
"type": "object",
"title": "User",
"required": [
"id",
"login",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the user."
},
"name": {
"type": "string",
"description": "The name of the user."
},
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
}
}
}
UserGetUserInformationdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
UserListCollaborationsResponse
{
"type": "array",
"items": {
"type": "object",
"title": "Collaboration",
"required": [
"id",
"vcs-type",
"name",
"avatar_url",
"slug"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"x-nullable": true,
"description": "The UUID of the organization"
},
"name": {
"type": "string",
"description": "The name of the organization"
},
"slug": {
"type": "string",
"description": "The slug of the organization"
},
"vcs-type": {
"type": "string",
"description": "The VCS provider"
},
"avatar_url": {
"type": "string",
"description": "URL to the user's avatar on the VCS"
}
}
}
}
UserListCollaborationsdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
Violation
{
"type": "object",
"required": [
"rule",
"reason"
],
"properties": {
"rule": {
"type": "string"
},
"reason": {
"type": "string"
}
}
}
WebhookCreateOutboundWebhookRequest
{
"type": "object",
"required": [
"name",
"events",
"url",
"verify-tls",
"signing-secret",
"scope"
],
"properties": {
"url": {
"type": "string",
"description": "URL to deliver the webhook to. Note: protocol must be included as well (only https is supported)"
},
"name": {
"type": "string",
"description": "Name of the webhook"
},
"scope": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of the scope being used (at the moment, only project ID is supported)"
},
"type": {
"enum": [
"project"
],
"type": "string",
"description": "Type of the scope being used"
}
},
"description": "The scope in which the relevant events that will trigger webhooks"
},
"events": {
"type": "array",
"items": {
"enum": [
"workflow-completed",
"job-completed"
],
"type": "string"
},
"description": "Events that will trigger the webhook"
},
"verify-tls": {
"type": "boolean",
"description": "Whether to enforce TLS certificate verification when delivering the webhook"
},
"signing-secret": {
"type": "string",
"description": "Secret used to build an HMAC hash of the payload and passed as a header in the webhook request"
}
},
"description": "The parameters for a create webhook request"
}
WebhookCreateOutboundWebhookResponse
{
"type": "object",
"title": "Webhook",
"required": [
"id",
"scope",
"name",
"events",
"url",
"verify-tls",
"signing-secret",
"created-at",
"updated-at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the webhook"
},
"url": {
"type": "string",
"description": "URL to deliver the webhook to. Note: protocol must be included as well (only https is supported)"
},
"name": {
"type": "string",
"description": "Name of the webhook"
},
"scope": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of the scope being used (at the moment, only project ID is supported)"
},
"type": {
"type": "string",
"description": "Type of the scope being used"
}
},
"description": "The scope in which the relevant events that will trigger webhooks"
},
"events": {
"type": "array",
"items": {
"enum": [
"workflow-completed",
"job-completed"
],
"type": "string"
},
"description": "Events that will trigger the webhook"
},
"created-at": {
"type": "string",
"format": "date-time",
"example": "2015-09-21T17:29:21.042Z",
"description": "The date and time the webhook was created."
},
"updated-at": {
"type": "string",
"format": "date-time",
"example": "2015-09-21T17:29:21.042Z",
"description": "The date and time the webhook was last updated."
},
"verify-tls": {
"type": "boolean",
"description": "Whether to enforce TLS certificate verification when delivering the webhook"
},
"signing-secret": {
"type": "string",
"description": "Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request"
}
}
}
WebhookCreateOutboundWebhookdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
WebhookDeleteOutboundWebhookResponse
{
"type": "object",
"title": "MessageResponse",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"description": "A human-readable message"
}
},
"description": "message response"
}
WebhookDeleteOutboundWebhookdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
WebhookGetByIdResponse
{
"type": "object",
"title": "Webhook",
"required": [
"id",
"scope",
"name",
"events",
"url",
"verify-tls",
"signing-secret",
"created-at",
"updated-at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the webhook"
},
"url": {
"type": "string",
"description": "URL to deliver the webhook to. Note: protocol must be included as well (only https is supported)"
},
"name": {
"type": "string",
"description": "Name of the webhook"
},
"scope": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of the scope being used (at the moment, only project ID is supported)"
},
"type": {
"type": "string",
"description": "Type of the scope being used"
}
},
"description": "The scope in which the relevant events that will trigger webhooks"
},
"events": {
"type": "array",
"items": {
"enum": [
"workflow-completed",
"job-completed"
],
"type": "string"
},
"description": "Events that will trigger the webhook"
},
"created-at": {
"type": "string",
"format": "date-time",
"example": "2015-09-21T17:29:21.042Z",
"description": "The date and time the webhook was created."
},
"updated-at": {
"type": "string",
"format": "date-time",
"example": "2015-09-21T17:29:21.042Z",
"description": "The date and time the webhook was last updated."
},
"verify-tls": {
"type": "boolean",
"description": "Whether to enforce TLS certificate verification when delivering the webhook"
},
"signing-secret": {
"type": "string",
"description": "Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request"
}
}
}
WebhookGetByIddefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
WebhookListMatchingScopeResponse
{
"type": "object",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Webhook",
"required": [
"id",
"scope",
"name",
"events",
"url",
"verify-tls",
"signing-secret",
"created-at",
"updated-at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the webhook"
},
"url": {
"type": "string",
"description": "URL to deliver the webhook to. Note: protocol must be included as well (only https is supported)"
},
"name": {
"type": "string",
"description": "Name of the webhook"
},
"scope": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of the scope being used (at the moment, only project ID is supported)"
},
"type": {
"type": "string",
"description": "Type of the scope being used"
}
},
"description": "The scope in which the relevant events that will trigger webhooks"
},
"events": {
"type": "array",
"items": {
"enum": [
"workflow-completed",
"job-completed"
],
"type": "string"
},
"description": "Events that will trigger the webhook"
},
"created-at": {
"type": "string",
"format": "date-time",
"example": "2015-09-21T17:29:21.042Z",
"description": "The date and time the webhook was created."
},
"updated-at": {
"type": "string",
"format": "date-time",
"example": "2015-09-21T17:29:21.042Z",
"description": "The date and time the webhook was last updated."
},
"verify-tls": {
"type": "boolean",
"description": "Whether to enforce TLS certificate verification when delivering the webhook"
},
"signing-secret": {
"type": "string",
"description": "Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request"
}
}
}
},
"next_page_token": {
"type": "string",
"x-nullable": true,
"description": "A token to pass as a `page-token` query parameter to return the next page of results."
}
},
"description": "A list of webhooks"
}