Get a single constraint identified by the name parameter

To get a single constraint identified by the name parameter, you must be authenticated by means of one of the following methods:
  • X-Authentication_Header
  • RBAC_Allowlisted_Certificate

GET /v1/constraints/{id}

Parameters

Name In Type Required Description
id path identifier true none

Response format

{
  "plans": [
    "string"
  ],
  "all_plans": false,
  "id": "http://example.com",
  "name": "9ffa9185-7453-4fb2-aa6a-3105a6ae83a8",
  "display_name": "string",
  "nodes": [
    "string"
  ],
  "node_groups": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "pql_query": "string"
}

Responses

Status Meaning Description Schema
200 OK Request was successful, returns an individual patch job. single-constraint
401 Unauthorized Authentication failed not-authenticated-error
404 Not Found Constraint not found error