CIcircleci
Context

Create context restriction

Creates project or expression restriction on a context.

post/context/{context_id}/restrictions

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/context/{context_id}/restrictions
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Request body

restriction_type'project' | 'expression' | 'group'

Type of the restriction.

restriction_valuestring

Value used to evaluate the restriction. If the restriction_type is project, this will be the project UUID. If the restriction_type is expression, this will be the expression rule.

Response

Successful response.

idstring uuid

UUID of the project restriction

project_idstring uuid

Deprecated - For "project" restrictions read the project ID from "restriction_value" instead.

UUID of the project used in a project restriction.

namestring

Contains a human-readable reference for the restriction. For "project" restrictions this is the name of the project.

May be null.

restriction_type'project' | 'expression' | 'group'

Type of the restriction

restriction_valuestring

Value used to evaluate the restriction

Changes

No recorded changes to this operation across all 1 revision of this API.