InsightsListProjectBranchesdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
JSONDuration
{
"type": "string",
"pattern": "^([0-9]+(ms|s|m|h|d|w)){1,7}$"
}
JobCancelWithNumberResponse
{
"type": "object",
"title": "MessageResponse",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"description": "A human-readable message"
}
},
"description": "message response"
}
JobCancelWithNumberdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
JobGetArtifactsResponse
{
"type": "object",
"title": "ArtifactListResponse",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Artifact",
"required": [
"path",
"node_index",
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL to download the artifact contents."
},
"path": {
"type": "string",
"description": "The artifact path."
},
"node_index": {
"type": "integer",
"format": "int64",
"minimum": 0,
"description": "The index of the node that stored the artifact."
}
},
"description": "An artifact"
}
},
"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."
}
}
}
JobGetArtifactsdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
JobGetDetailsResponse
{
"type": "object",
"title": "Job Details",
"required": [
"number",
"name",
"status",
"started_at",
"created_at",
"queued_at",
"duration",
"executor",
"project",
"organization",
"contexts",
"web_url",
"parallel_runs",
"latest_workflow",
"pipeline",
"parallelism",
"messages"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the job."
},
"number": {
"type": "integer",
"format": "int64",
"description": "The number of the job."
},
"status": {
"enum": [
"success",
"running",
"not_run",
"failed",
"retried",
"queued",
"not_running",
"infrastructure_fail",
"timedout",
"on_hold",
"terminated-unknown",
"blocked",
"canceled",
"unauthorized"
],
"type": "string",
"description": "The current status of the job."
},
"project": {
"type": "object",
"required": [
"id",
"slug",
"name",
"external_url"
],
"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)."
},
"external_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL to the repository hosting the project's code"
}
},
"description": "Information about a project."
},
"web_url": {
"type": "string",
"description": "URL of the job in CircleCI Web UI."
},
"contexts": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the context."
}
},
"description": "Information about the context."
},
"description": "List of contexts used by the job."
},
"duration": {
"type": "integer",
"format": "int64",
"x-nullable": true,
"description": "Duration of a job in milliseconds."
},
"executor": {
"type": "object",
"required": [
"resource_class"
],
"properties": {
"type": {
"type": "string",
"description": "Executor type."
},
"resource_class": {
"type": "string",
"description": "Resource class name."
}
},
"description": "Information about executor used for a job."
},
"messages": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"message"
],
"properties": {
"type": {
"type": "string",
"description": "Message type."
},
"reason": {
"type": "string",
"description": "Value describing the reason for message to be added to the job."
},
"message": {
"type": "string",
"description": "Information describing message."
}
},
"description": "Message from CircleCI execution platform."
},
"description": "Messages from CircleCI execution platform."
},
"pipeline": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "5034460f-c7c4-4c43-9457-de07e2029e7b",
"description": "The unique ID of the pipeline."
}
},
"description": "Info about a pipeline the job is a part of."
},
"queued_at": {
"type": "string",
"format": "date-time",
"description": "The time when the job was placed in a queue."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The time when the job was created."
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the job started."
},
"stopped_at": {
"type": "string",
"format": "date-time",
"x-nullable": true,
"description": "The time when the job stopped."
},
"parallelism": {
"type": "integer",
"format": "int64",
"description": "A number of parallel runs the job has."
},
"organization": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the organization."
}
},
"description": "Information about an organization."
},
"parallel_runs": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"status"
],
"properties": {
"index": {
"type": "integer",
"format": "int64",
"description": "Index of the parallel run."
},
"status": {
"type": "string",
"description": "Status of the parallel run."
}
},
"description": "Info about a status of the parallel run."
},
"description": "Info about parallels runs and their status."
},
"latest_workflow": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the workflow."
},
"name": {
"type": "string",
"example": "build-and-test",
"description": "The name of the workflow."
}
},
"description": "Info about the latest workflow the job was a part of."
}
},
"description": "Job Details"
}
JobGetDetailsdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
JobGetTestMetadataResponse
{
"type": "object",
"title": "TestsResponse",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"message",
"source",
"run_time",
"file",
"result",
"name",
"classname"
],
"properties": {
"file": {
"type": "string",
"example": "",
"description": "The file in which the test is defined."
},
"name": {
"type": "string",
"example": "",
"description": "The name of the test."
},
"result": {
"type": "string",
"example": "",
"description": "Indication of whether the test succeeded."
},
"source": {
"type": "string",
"example": "",
"description": "The program that generated the test results"
},
"message": {
"type": "string",
"example": "",
"x-nullable": true,
"description": "The failure message associated with the test."
},
"run_time": {
"type": "number",
"format": "double",
"example": null,
"description": "The time it took to run the test in seconds"
},
"classname": {
"type": "string",
"example": "",
"description": "The programmatic location of the test."
}
}
},
"title": "TestsResponse"
},
"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."
}
}
}
JobGetTestMetadatadefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
OidcTokenManagementDeleteOrgClaims403Response
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "Forbidden"
}
}
}
OidcTokenManagementDeleteOrgClaims500Response
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "internal server error"
}
}
}
OidcTokenManagementDeleteOrgClaimsResponse
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "OwnerID: must be a valid UUID."
}
}
}
PatchClaimsRequest
{
"type": "object",
"properties": {
"ttl": {
"$ref": "#/components/schemas/JSONDuration"
},
"audience": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
PipelineContinueExecutionRequest
{
"type": "object",
"required": [
"continuation-key",
"configuration"
],
"properties": {
"parameters": {
"type": "object",
"example": {
"deploy_prod": true
},
"description": "An object containing pipeline parameters and their values.",
"additionalProperties": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"configuration": {
"type": "string",
"description": "A configuration string for the pipeline."
},
"continuation-key": {
"type": "string",
"title": "PipelineContinuationKey",
"description": "A pipeline continuation key."
}
}
}
PipelineContinueExecutionResponse
{
"type": "object",
"title": "MessageResponse",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"description": "A human-readable message"
}
},
"description": "message response"
}
PipelineContinueExecutiondefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
PipelineGetAllPipelinesResponse
{
"type": "object",
"title": "PipelineListResponse",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Pipeline",
"required": [
"id",
"number",
"project_slug",
"created_at",
"errors",
"state",
"trigger"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "5034460f-c7c4-4c43-9457-de07e2029e7b",
"description": "The unique ID of the pipeline."
},
"vcs": {
"type": "object",
"required": [
"provider_name",
"origin_repository_url",
"target_repository_url",
"revision"
],
"properties": {
"tag": {
"type": "string",
"example": "v3.1.4159",
"description": "The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive."
},
"branch": {
"type": "string",
"example": "feature/design-new-api",
"description": "The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull/<number>/head` for the PR ref or `pull/<number>/merge` for the merge ref (GitHub only)."
},
"commit": {
"type": "object",
"required": [
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"x-nullable": true,
"description": "The body of the commit message."
},
"subject": {
"type": "string",
"x-nullable": true,
"description": "The subject of the commit message."
}
},
"description": "The latest commit in the pipeline."
},
"revision": {
"type": "string",
"example": "f454a02b5d10fcccfd7d9dd7608a76d6493a98b4",
"description": "The code revision the pipeline ran."
},
"review_id": {
"type": "string",
"example": "123",
"description": "The code review id."
},
"review_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs/pull/123",
"description": "The code review URL."
},
"provider_name": {
"type": "string",
"example": "GitHub",
"description": "Name of the VCS provider (e.g. GitHub, Bitbucket)."
},
"origin_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same."
},
"target_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same."
}
},
"description": "VCS information for the pipeline."
},
"state": {
"enum": [
"created",
"errored",
"setup-pending",
"setup",
"pending"
],
"type": "string",
"description": "The current state of the pipeline."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"message"
],
"properties": {
"type": {
"enum": [
"config",
"config-fetch",
"timeout",
"permission",
"other",
"plan"
],
"type": "string",
"description": "The type of error."
},
"message": {
"type": "string",
"description": "A human-readable error message."
}
},
"description": "An error with a type and message."
},
"description": "A sequence of errors that have occurred within the pipeline."
},
"number": {
"type": "integer",
"format": "int64",
"example": 25,
"description": "The number of the pipeline."
},
"trigger": {
"type": "object",
"required": [
"type",
"received_at",
"actor"
],
"properties": {
"type": {
"enum": [
"scheduled_pipeline",
"explicit",
"api",
"webhook"
],
"type": "string",
"description": "The type of trigger."
},
"actor": {
"type": "object",
"required": [
"login",
"avatar_url"
],
"properties": {
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
},
"avatar_url": {
"type": "string",
"x-nullable": true,
"description": "URL to the user's avatar on the VCS"
}
},
"description": "The user who triggered the Pipeline."
},
"received_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the trigger was received."
}
},
"description": "A summary of the trigger."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was last updated."
},
"project_slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the pipeline."
},
"trigger_parameters": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
}
},
"description": "A pipeline 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": "List of pipelines"
}
PipelineGetAllPipelinesdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
PipelineGetByIdResponse
{
"type": "object",
"title": "Pipeline",
"required": [
"id",
"number",
"project_slug",
"created_at",
"errors",
"state",
"trigger"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "5034460f-c7c4-4c43-9457-de07e2029e7b",
"description": "The unique ID of the pipeline."
},
"vcs": {
"type": "object",
"required": [
"provider_name",
"origin_repository_url",
"target_repository_url",
"revision"
],
"properties": {
"tag": {
"type": "string",
"example": "v3.1.4159",
"description": "The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive."
},
"branch": {
"type": "string",
"example": "feature/design-new-api",
"description": "The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull/<number>/head` for the PR ref or `pull/<number>/merge` for the merge ref (GitHub only)."
},
"commit": {
"type": "object",
"required": [
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"x-nullable": true,
"description": "The body of the commit message."
},
"subject": {
"type": "string",
"x-nullable": true,
"description": "The subject of the commit message."
}
},
"description": "The latest commit in the pipeline."
},
"revision": {
"type": "string",
"example": "f454a02b5d10fcccfd7d9dd7608a76d6493a98b4",
"description": "The code revision the pipeline ran."
},
"review_id": {
"type": "string",
"example": "123",
"description": "The code review id."
},
"review_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs/pull/123",
"description": "The code review URL."
},
"provider_name": {
"type": "string",
"example": "GitHub",
"description": "Name of the VCS provider (e.g. GitHub, Bitbucket)."
},
"origin_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same."
},
"target_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same."
}
},
"description": "VCS information for the pipeline."
},
"state": {
"enum": [
"created",
"errored",
"setup-pending",
"setup",
"pending"
],
"type": "string",
"description": "The current state of the pipeline."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"message"
],
"properties": {
"type": {
"enum": [
"config",
"config-fetch",
"timeout",
"permission",
"other",
"plan"
],
"type": "string",
"description": "The type of error."
},
"message": {
"type": "string",
"description": "A human-readable error message."
}
},
"description": "An error with a type and message."
},
"description": "A sequence of errors that have occurred within the pipeline."
},
"number": {
"type": "integer",
"format": "int64",
"example": 25,
"description": "The number of the pipeline."
},
"trigger": {
"type": "object",
"required": [
"type",
"received_at",
"actor"
],
"properties": {
"type": {
"enum": [
"scheduled_pipeline",
"explicit",
"api",
"webhook"
],
"type": "string",
"description": "The type of trigger."
},
"actor": {
"type": "object",
"required": [
"login",
"avatar_url"
],
"properties": {
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
},
"avatar_url": {
"type": "string",
"x-nullable": true,
"description": "URL to the user's avatar on the VCS"
}
},
"description": "The user who triggered the Pipeline."
},
"received_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the trigger was received."
}
},
"description": "A summary of the trigger."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was last updated."
},
"project_slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the pipeline."
},
"trigger_parameters": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
}
},
"description": "A pipeline response."
}
PipelineGetByIddefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
PipelineGetByNumberResponse
{
"type": "object",
"title": "Pipeline",
"required": [
"id",
"number",
"project_slug",
"created_at",
"errors",
"state",
"trigger"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "5034460f-c7c4-4c43-9457-de07e2029e7b",
"description": "The unique ID of the pipeline."
},
"vcs": {
"type": "object",
"required": [
"provider_name",
"origin_repository_url",
"target_repository_url",
"revision"
],
"properties": {
"tag": {
"type": "string",
"example": "v3.1.4159",
"description": "The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive."
},
"branch": {
"type": "string",
"example": "feature/design-new-api",
"description": "The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull/<number>/head` for the PR ref or `pull/<number>/merge` for the merge ref (GitHub only)."
},
"commit": {
"type": "object",
"required": [
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"x-nullable": true,
"description": "The body of the commit message."
},
"subject": {
"type": "string",
"x-nullable": true,
"description": "The subject of the commit message."
}
},
"description": "The latest commit in the pipeline."
},
"revision": {
"type": "string",
"example": "f454a02b5d10fcccfd7d9dd7608a76d6493a98b4",
"description": "The code revision the pipeline ran."
},
"review_id": {
"type": "string",
"example": "123",
"description": "The code review id."
},
"review_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs/pull/123",
"description": "The code review URL."
},
"provider_name": {
"type": "string",
"example": "GitHub",
"description": "Name of the VCS provider (e.g. GitHub, Bitbucket)."
},
"origin_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same."
},
"target_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same."
}
},
"description": "VCS information for the pipeline."
},
"state": {
"enum": [
"created",
"errored",
"setup-pending",
"setup",
"pending"
],
"type": "string",
"description": "The current state of the pipeline."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"message"
],
"properties": {
"type": {
"enum": [
"config",
"config-fetch",
"timeout",
"permission",
"other",
"plan"
],
"type": "string",
"description": "The type of error."
},
"message": {
"type": "string",
"description": "A human-readable error message."
}
},
"description": "An error with a type and message."
},
"description": "A sequence of errors that have occurred within the pipeline."
},
"number": {
"type": "integer",
"format": "int64",
"example": 25,
"description": "The number of the pipeline."
},
"trigger": {
"type": "object",
"required": [
"type",
"received_at",
"actor"
],
"properties": {
"type": {
"enum": [
"scheduled_pipeline",
"explicit",
"api",
"webhook"
],
"type": "string",
"description": "The type of trigger."
},
"actor": {
"type": "object",
"required": [
"login",
"avatar_url"
],
"properties": {
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
},
"avatar_url": {
"type": "string",
"x-nullable": true,
"description": "URL to the user's avatar on the VCS"
}
},
"description": "The user who triggered the Pipeline."
},
"received_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the trigger was received."
}
},
"description": "A summary of the trigger."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was last updated."
},
"project_slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the pipeline."
},
"trigger_parameters": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
}
},
"description": "A pipeline response."
}
PipelineGetByNumberdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
PipelineGetConfigurationByIdResponse
{
"type": "object",
"title": "PipelineConfig",
"required": [
"source",
"compiled"
],
"properties": {
"source": {
"type": "string",
"description": "The source configuration for the pipeline, before any config compilation has been performed. If there is no config, then this field will be empty."
},
"compiled": {
"type": "string",
"description": "The compiled configuration for the pipeline, after all orb expansion has been performed. If there were errors processing the pipeline's configuration, then this field may be empty."
},
"setup-config": {
"type": "string",
"description": "The setup configuration for the pipeline used for Setup Workflows. If there were errors processing the pipeline's configuration or if setup workflows are not enabled, then this field should not exist"
},
"compiled-setup-config": {
"type": "string",
"description": "The compiled setup configuration for the pipeline, after all orb expansion has been performed. If there were errors processing the pipeline's setup workflows, then this field may be empty."
}
},
"description": "The configuration strings for the pipeline."
}
PipelineGetConfigurationByIddefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
PipelineListRecentPipelinesResponse
{
"type": "object",
"title": "PipelineListResponse",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Pipeline",
"required": [
"id",
"number",
"project_slug",
"created_at",
"errors",
"state",
"trigger"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "5034460f-c7c4-4c43-9457-de07e2029e7b",
"description": "The unique ID of the pipeline."
},
"vcs": {
"type": "object",
"required": [
"provider_name",
"origin_repository_url",
"target_repository_url",
"revision"
],
"properties": {
"tag": {
"type": "string",
"example": "v3.1.4159",
"description": "The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive."
},
"branch": {
"type": "string",
"example": "feature/design-new-api",
"description": "The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull/<number>/head` for the PR ref or `pull/<number>/merge` for the merge ref (GitHub only)."
},
"commit": {
"type": "object",
"required": [
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"x-nullable": true,
"description": "The body of the commit message."
},
"subject": {
"type": "string",
"x-nullable": true,
"description": "The subject of the commit message."
}
},
"description": "The latest commit in the pipeline."
},
"revision": {
"type": "string",
"example": "f454a02b5d10fcccfd7d9dd7608a76d6493a98b4",
"description": "The code revision the pipeline ran."
},
"review_id": {
"type": "string",
"example": "123",
"description": "The code review id."
},
"review_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs/pull/123",
"description": "The code review URL."
},
"provider_name": {
"type": "string",
"example": "GitHub",
"description": "Name of the VCS provider (e.g. GitHub, Bitbucket)."
},
"origin_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same."
},
"target_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same."
}
},
"description": "VCS information for the pipeline."
},
"state": {
"enum": [
"created",
"errored",
"setup-pending",
"setup",
"pending"
],
"type": "string",
"description": "The current state of the pipeline."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"message"
],
"properties": {
"type": {
"enum": [
"config",
"config-fetch",
"timeout",
"permission",
"other",
"plan"
],
"type": "string",
"description": "The type of error."
},
"message": {
"type": "string",
"description": "A human-readable error message."
}
},
"description": "An error with a type and message."
},
"description": "A sequence of errors that have occurred within the pipeline."
},
"number": {
"type": "integer",
"format": "int64",
"example": 25,
"description": "The number of the pipeline."
},
"trigger": {
"type": "object",
"required": [
"type",
"received_at",
"actor"
],
"properties": {
"type": {
"enum": [
"scheduled_pipeline",
"explicit",
"api",
"webhook"
],
"type": "string",
"description": "The type of trigger."
},
"actor": {
"type": "object",
"required": [
"login",
"avatar_url"
],
"properties": {
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
},
"avatar_url": {
"type": "string",
"x-nullable": true,
"description": "URL to the user's avatar on the VCS"
}
},
"description": "The user who triggered the Pipeline."
},
"received_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the trigger was received."
}
},
"description": "A summary of the trigger."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was last updated."
},
"project_slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the pipeline."
},
"trigger_parameters": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
}
},
"description": "A pipeline 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": "List of pipelines"
}
PipelineListRecentPipelinesdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
PipelineListUserPipelinesResponse
{
"type": "object",
"title": "PipelineListResponse",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Pipeline",
"required": [
"id",
"number",
"project_slug",
"created_at",
"errors",
"state",
"trigger"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "5034460f-c7c4-4c43-9457-de07e2029e7b",
"description": "The unique ID of the pipeline."
},
"vcs": {
"type": "object",
"required": [
"provider_name",
"origin_repository_url",
"target_repository_url",
"revision"
],
"properties": {
"tag": {
"type": "string",
"example": "v3.1.4159",
"description": "The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive."
},
"branch": {
"type": "string",
"example": "feature/design-new-api",
"description": "The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull/<number>/head` for the PR ref or `pull/<number>/merge` for the merge ref (GitHub only)."
},
"commit": {
"type": "object",
"required": [
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"x-nullable": true,
"description": "The body of the commit message."
},
"subject": {
"type": "string",
"x-nullable": true,
"description": "The subject of the commit message."
}
},
"description": "The latest commit in the pipeline."
},
"revision": {
"type": "string",
"example": "f454a02b5d10fcccfd7d9dd7608a76d6493a98b4",
"description": "The code revision the pipeline ran."
},
"review_id": {
"type": "string",
"example": "123",
"description": "The code review id."
},
"review_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs/pull/123",
"description": "The code review URL."
},
"provider_name": {
"type": "string",
"example": "GitHub",
"description": "Name of the VCS provider (e.g. GitHub, Bitbucket)."
},
"origin_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same."
},
"target_repository_url": {
"type": "string",
"example": "https://github.com/CircleCI-Public/api-preview-docs",
"description": "URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same."
}
},
"description": "VCS information for the pipeline."
},
"state": {
"enum": [
"created",
"errored",
"setup-pending",
"setup",
"pending"
],
"type": "string",
"description": "The current state of the pipeline."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"message"
],
"properties": {
"type": {
"enum": [
"config",
"config-fetch",
"timeout",
"permission",
"other",
"plan"
],
"type": "string",
"description": "The type of error."
},
"message": {
"type": "string",
"description": "A human-readable error message."
}
},
"description": "An error with a type and message."
},
"description": "A sequence of errors that have occurred within the pipeline."
},
"number": {
"type": "integer",
"format": "int64",
"example": 25,
"description": "The number of the pipeline."
},
"trigger": {
"type": "object",
"required": [
"type",
"received_at",
"actor"
],
"properties": {
"type": {
"enum": [
"scheduled_pipeline",
"explicit",
"api",
"webhook"
],
"type": "string",
"description": "The type of trigger."
},
"actor": {
"type": "object",
"required": [
"login",
"avatar_url"
],
"properties": {
"login": {
"type": "string",
"title": "Login",
"description": "The login information for the user on the VCS."
},
"avatar_url": {
"type": "string",
"x-nullable": true,
"description": "URL to the user's avatar on the VCS"
}
},
"description": "The user who triggered the Pipeline."
},
"received_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the trigger was received."
}
},
"description": "A summary of the trigger."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was last updated."
},
"project_slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the pipeline."
},
"trigger_parameters": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
}
},
"description": "A pipeline 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": "List of pipelines"
}
PipelineListUserPipelinesdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
PipelineListWorkflowsResponse
{
"type": "object",
"title": "WorkflowListResponse",
"required": [
"items",
"next_page_token"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Workflow",
"required": [
"id",
"name",
"status",
"created_at",
"stopped_at",
"pipeline_id",
"pipeline_number",
"project_slug",
"started_by"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the workflow."
},
"tag": {
"enum": [
"setup"
],
"type": "string",
"example": "setup",
"x-nullable": true,
"description": "Tag used for the workflow"
},
"name": {
"type": "string",
"example": "build-and-test",
"description": "The name of the workflow."
},
"status": {
"enum": [
"success",
"running",
"not_run",
"failed",
"error",
"failing",
"on_hold",
"canceled",
"unauthorized"
],
"type": "string",
"description": "The current status of the workflow."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the workflow was created."
},
"errored_by": {
"type": "string",
"format": "uuid"
},
"started_by": {
"type": "string",
"format": "uuid"
},
"stopped_at": {
"type": "string",
"format": "date-time",
"x-nullable": true,
"description": "The date and time the workflow stopped."
},
"canceled_by": {
"type": "string",
"format": "uuid"
},
"pipeline_id": {
"type": "string",
"format": "uuid",
"example": "5034460f-c7c4-4c43-9457-de07e2029e7b",
"description": "The ID of the pipeline this workflow belongs to."
},
"project_slug": {
"type": "string",
"example": "gh/CircleCI-Public/api-preview-docs",
"description": "The project-slug for the pipeline this workflow belongs to."
},
"pipeline_number": {
"type": "integer",
"format": "int64",
"example": 25,
"description": "The number of the pipeline this workflow belongs to."
}
},
"description": "A workflow"
},
"title": "Workflow list",
"description": "A list of workflows."
},
"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 workflows and associated pagination token."
}
PipelineListWorkflowsdefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
PipelineTriggerNewPipelineRequest
{
"type": "object",
"title": "TriggerPipelineParameters",
"properties": {
"tag": {
"type": "string",
"example": "v3.1.4159",
"description": "The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive."
},
"branch": {
"type": "string",
"example": "feature/design-new-api",
"description": "The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull/<number>/head` for the PR ref or `pull/<number>/merge` for the merge ref (GitHub only)."
},
"parameters": {
"type": "object",
"example": {
"deploy_prod": true
},
"description": "An object containing pipeline parameters and their values.",
"additionalProperties": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
}
}
},
"x-nullable": true,
"description": "The information you can supply when triggering a pipeline."
}
PipelineTriggerNewPipelineResponse
{
"type": "object",
"title": "PipelineCreation",
"required": [
"id",
"state",
"number",
"created_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "5034460f-c7c4-4c43-9457-de07e2029e7b",
"description": "The unique ID of the pipeline."
},
"state": {
"enum": [
"created",
"errored",
"setup-pending",
"setup",
"pending"
],
"type": "string",
"description": "The current state of the pipeline."
},
"number": {
"type": "integer",
"format": "int64",
"example": 25,
"description": "The number of the pipeline."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the pipeline was created."
}
},
"description": "A pipeline creation response."
}
PipelineTriggerNewPipelinedefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
Policy
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"content": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"created_by": {
"type": "string"
}
}
}
PolicyBundle
{
"type": "object",
"additionalProperties": {
"items": {
"$ref": "#/components/schemas/Policy"
}
}
}
PolicyManagementCreatePolicyBundleForContextResponse
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "http: request payload too large"
}
}
}
PolicyManagementEvaluateInputData401Response
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "Unauthorized."
}
}
}
PolicyManagementEvaluateInputData500Response
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "There was an error processing your request."
}
}
}
PolicyManagementEvaluateInputDataRequest
{
"type": "object",
"required": [
"input"
],
"properties": {
"input": {
"type": "string"
},
"metadata": {
"type": "object"
}
}
}
PolicyManagementEvaluateInputDataResponse
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "context: must be a valid value."
}
}
}
PolicyManagementGetDecisionAuditLogByGivenIdResponse
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "decision log not found"
}
}
}
PolicyManagementGetDecisionAuditLogs401Response
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "Unauthorized"
}
}
}
PolicyManagementGetDecisionAuditLogs500Response
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "unexpected server error"
}
}
}
PolicyManagementGetDecisionAuditLogsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DecisionLog"
}
}
PolicyManagementGetDocumentResponse
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "policy not found"
}
}
}
PolicyManagementGetPolicyBundleForDecisionResponse
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "decision log not found"
}
}
}
ProjectCreateCheckoutKeyRequest
{
"type": "object",
"title": "CheckoutKeyInput",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user-key",
"deploy-key"
],
"type": "string",
"title": "CheckoutKeyInputType",
"example": "deploy-key",
"description": "The type of checkout key to create. This may be either `deploy-key` or `user-key`."
}
}
}
ProjectCreateCheckoutKeyResponse
{
"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"
}
ProjectCreateCheckoutKeydefaultResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}