Docs
Start for free Sign in
Theme
Sign in Start for free

Compliance Policies

Request the published versions for a policy

GET /api/platformhub/policies/{slug}/versions

Path Parameters

  • slug string (required)

Query Parameters

  • skip integer
    Number of items to skip. Defaults to zero. Minimum 0.
  • take integer
    Number of items to take. Defaults to 30. Minimum 0.

Response

200 — The requested policy version

  • Description string
  • GitCommit string
  • GitRef string
    Minimum length 1.
  • Id string
    Minimum length 1.
  • IsActive boolean
  • Name string
    Minimum length 1.
  • PublishedDate string
    Format date-time.
  • RegoConditions string
    Minimum length 1.
  • RegoScope string
    Minimum length 1.
  • Slug string
    Minimum length 1.
  • Version string
    Minimum length 1.
  • ViolationAction string
    Minimum length 1.
  • ViolationReason string

Example Response

JSON
[
  {
    "Description": "string",
    "GitCommit": "string",
    "GitRef": "string",
    "Id": "string",
    "IsActive": true,
    "Name": "string",
    "PublishedDate": "2020-01-01T00:00:00.000Z",
    "RegoConditions": "string",
    "RegoScope": "string",
    "Slug": "string",
    "Version": "string",
    "ViolationAction": "string",
    "ViolationReason": "string"
  }
]

Request the published versions for a policy

GET /api/platformhub/policies/{slug}/versions/v2

Path Parameters

  • slug string (required)

Query Parameters

  • skip integer
    Number of items to skip. Defaults to zero. Minimum 0.
  • take integer
    Number of items to take. Defaults to 30. Minimum 0.

Response

200 — Success

  • ItemType string
  • Items array of object
    • Description string
    • GitCommit string
    • GitRef string
      Minimum length 1.
    • Id string
      Minimum length 1.
    • IsActive boolean
    • Name string
      Minimum length 1.
    • PublishedDate string
      Format date-time.
    • RegoConditions string
      Minimum length 1.
    • RegoScope string
      Minimum length 1.
    • Slug string
      Minimum length 1.
    • Version string
      Minimum length 1.
    • ViolationAction string
      Minimum length 1.
    • ViolationReason string
  • ItemsPerPage integer
  • LastPageNumber integer
  • NumberOfPages integer
  • TotalResults integer

Example Response

JSON
{
  "ItemType": "string",
  "Items": [
    {
      "Description": "string",
      "GitCommit": "string",
      "GitRef": "string",
      "Id": "string",
      "IsActive": true,
      "Name": "string",
      "PublishedDate": "2020-01-01T00:00:00.000Z",
      "RegoConditions": "string",
      "RegoScope": "string",
      "Slug": "string",
      "Version": "string",
      "ViolationAction": "string",
      "ViolationReason": "string"
    }
  ],
  "ItemsPerPage": 0,
  "LastPageNumber": 0,
  "NumberOfPages": 0,
  "TotalResults": 0
}

Modify the activation status for a policy version

POST /api/platformhub/policies/{slug}/versions/{version}/modify-status

Path Parameters

  • slug string (required)
  • version string (required)

Request Body

  • IsActive boolean (required)
  • Slug string (required)
    Minimum length 1.
  • Version string (required)
    Minimum length 1.

Response

200 — The requested policy version

  • Description string
  • GitCommit string
  • GitRef string
    Minimum length 1.
  • Id string
    Minimum length 1.
  • IsActive boolean
  • Name string
    Minimum length 1.
  • PublishedDate string
    Format date-time.
  • RegoConditions string
    Minimum length 1.
  • RegoScope string
    Minimum length 1.
  • Slug string
    Minimum length 1.
  • Version string
    Minimum length 1.
  • ViolationAction string
    Minimum length 1.
  • ViolationReason string

Example Request

JSON
{
  "IsActive": true,
  "Slug": "string",
  "Version": "string"
}

Example Response

JSON
{
  "Description": "string",
  "GitCommit": "string",
  "GitRef": "string",
  "Id": "string",
  "IsActive": true,
  "Name": "string",
  "PublishedDate": "2020-01-01T00:00:00.000Z",
  "RegoConditions": "string",
  "RegoScope": "string",
  "Slug": "string",
  "Version": "string",
  "ViolationAction": "string",
  "ViolationReason": "string"
}

Request a paginated set of CompliancePolicyResource sorted by name

GET /api/platformhub/{gitRef}/policies

Path Parameters

  • gitRef string (required)

Query Parameters

  • partialName string
  • skip integer
    Number of items to skip. Defaults to zero. Minimum 0.
  • take integer
    Number of items to take. Defaults to 30. Minimum 0.

Response

200 — A paginated set of CompliancePolicyResource sorted by name

  • FilteredItemsCount integer
  • ItemsPerPage integer
  • Policies array of object
    • ConditionsRego string
      Minimum length 1.
    • Description string
    • GitRef string
      Minimum length 1.
    • Name string
      Minimum length 1.
    • ScopeRego string
      Minimum length 1.
    • Slug string
      Minimum length 1.
    • ViolationAction string
      Minimum length 1.
    • ViolationReason string
  • TotalItemsCount integer

Example Response

JSON
{
  "FilteredItemsCount": 0,
  "ItemsPerPage": 0,
  "Policies": [
    {
      "ConditionsRego": "string",
      "Description": "string",
      "GitRef": "string",
      "Name": "string",
      "ScopeRego": "string",
      "Slug": "string",
      "ViolationAction": "string",
      "ViolationReason": "string"
    }
  ],
  "TotalItemsCount": 0
}

Create a new policy

POST /api/platformhub/{gitRef}/policies

Path Parameters

  • gitRef string (required)

Request Body

  • ChangeDescription string
  • ConditionsRego string (required)
    Minimum length 1.
  • Description string
  • GitRef string (required)
  • Name string (required)
    Minimum length 1.
  • ScopeRego string (required)
    Minimum length 1.
  • Slug string (required)
    Minimum length 1.
  • ViolationAction string (required)
    Minimum length 1.
  • ViolationReason string

Response

201 — Created

  • ConditionsRego string
    Minimum length 1.
  • Description string
  • GitRef string
    Minimum length 1.
  • Name string
    Minimum length 1.
  • ScopeRego string
    Minimum length 1.
  • Slug string
    Minimum length 1.
  • ViolationAction string
    Minimum length 1.
  • ViolationReason string

Example Request

JSON
{
  "ChangeDescription": "string",
  "ConditionsRego": "string",
  "Description": "string",
  "GitRef": "string",
  "Name": "string",
  "ScopeRego": "string",
  "Slug": "string",
  "ViolationAction": "string",
  "ViolationReason": "string"
}

Example Response

JSON
{
  "ConditionsRego": "string",
  "Description": "string",
  "GitRef": "string",
  "Name": "string",
  "ScopeRego": "string",
  "Slug": "string",
  "ViolationAction": "string",
  "ViolationReason": "string"
}

Request a single CompliancePolicyResource by slug and git reference

GET /api/platformhub/{gitRef}/policies/{slug}

Path Parameters

  • gitRef string (required)
  • slug string (required)

Response

200 — Represents a Compliance Policy

  • ConditionsRego string
    Minimum length 1.
  • Description string
  • GitRef string
    Minimum length 1.
  • Name string
    Minimum length 1.
  • ScopeRego string
    Minimum length 1.
  • Slug string
    Minimum length 1.
  • ViolationAction string
    Minimum length 1.
  • ViolationReason string

Example Response

JSON
{
  "ConditionsRego": "string",
  "Description": "string",
  "GitRef": "string",
  "Name": "string",
  "ScopeRego": "string",
  "Slug": "string",
  "ViolationAction": "string",
  "ViolationReason": "string"
}

Modify an existing policy

PUT /api/platformhub/{gitRef}/policies/{slug}

Path Parameters

  • gitRef string (required)
  • slug string (required)

Request Body

  • ChangeDescription string
  • ConditionsRego string (required)
    Minimum length 1.
  • Description string
  • GitRef string (required)
  • Name string (required)
    Minimum length 1.
  • ScopeRego string (required)
    Minimum length 1.
  • Slug string (required)
    Minimum length 1.
  • ViolationAction string (required)
    Minimum length 1.
  • ViolationReason string

Response

200 — Represents a Compliance Policy

  • ConditionsRego string
    Minimum length 1.
  • Description string
  • GitRef string
    Minimum length 1.
  • Name string
    Minimum length 1.
  • ScopeRego string
    Minimum length 1.
  • Slug string
    Minimum length 1.
  • ViolationAction string
    Minimum length 1.
  • ViolationReason string

Example Request

JSON
{
  "ChangeDescription": "string",
  "ConditionsRego": "string",
  "Description": "string",
  "GitRef": "string",
  "Name": "string",
  "ScopeRego": "string",
  "Slug": "string",
  "ViolationAction": "string",
  "ViolationReason": "string"
}

Example Response

JSON
{
  "ConditionsRego": "string",
  "Description": "string",
  "GitRef": "string",
  "Name": "string",
  "ScopeRego": "string",
  "Slug": "string",
  "ViolationAction": "string",
  "ViolationReason": "string"
}

Create new version of policy

POST /api/platformhub/{gitRef}/policies/{slug}/publish

Path Parameters

  • gitRef string (required)
  • slug string (required)

Request Body

  • GitRef string (required)
  • Slug string (required)
    Minimum length 1.
  • Version string (required)
    Minimum length 1.

Response

200 — The requested policy version

  • Description string
  • GitCommit string
  • GitRef string
    Minimum length 1.
  • Id string
    Minimum length 1.
  • IsActive boolean
  • Name string
    Minimum length 1.
  • PublishedDate string
    Format date-time.
  • RegoConditions string
    Minimum length 1.
  • RegoScope string
    Minimum length 1.
  • Slug string
    Minimum length 1.
  • Version string
    Minimum length 1.
  • ViolationAction string
    Minimum length 1.
  • ViolationReason string

Example Request

JSON
{
  "GitRef": "string",
  "Slug": "string",
  "Version": "string"
}

Example Response

JSON
{
  "Description": "string",
  "GitCommit": "string",
  "GitRef": "string",
  "Id": "string",
  "IsActive": true,
  "Name": "string",
  "PublishedDate": "2020-01-01T00:00:00.000Z",
  "RegoConditions": "string",
  "RegoScope": "string",
  "Slug": "string",
  "Version": "string",
  "ViolationAction": "string",
  "ViolationReason": "string"
}
Navigate Select Esc Close