CLcloudsmith
workspaces

GET /workspaces/{workspace}/policies/{policy}/simulate/

Changed on

Simulates the execution of a Policy to verify its behavior without taking any actions.

Before using this endpoint, the Policy to simulate must be created with the creation endpoint. To experiment with the policy, it is recommended to create the policy with disabled=True, so that it does not take effect outside the simulation endpoint.

This endpoint evaluates all packages in the workspace, generating a "decision log" for each evaluation. Each log contains:

  • Package metadata provided to the policy engine at runtime.
  • Output from the user-defined Rego policy.

No actions associated with the policy are executed. Instead, the endpoint reports what would happen to each package if the policy were active.

Request

  • Base URL
    https://api.cloudsmith.io/v2
  • Auth
    • API key in header X-Api-Key
    • or HTTP basic

Path parameters

policystring required

The slug_perm (identifier) of the Policy.

workspacestring required

The name of the Workspace.

Query parameters

package_query_stringstring

A package search query by which to filter the packages being evaluated.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

Changes

  • 1166a51a1a72Revision changes
    • breaking

      added to the /// response property oneOf list for the response status

    • info

      added BlockPackage discriminator mapping keys to the /// response property for the response status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

  • e67078c585d7Revision changes
    • breaking

      added to the //// response property oneOf list for the response status

    • info

      added MavenPackage discriminator mapping keys to the //// response property for the response status