v1

latestOpenAPI 3.0.1Apache 2.02026-07-17111176225.7 KB
Policies

Add a new policy

Adds a new policy bundle to the system

post/policies

Headers

x-anchore-accountstring

An account name to change the resource scope of the request to that account, if permissions allow (admin only)

Request body

idstring required

Id of the bundle

namestring

Human readable name for the bundle

commentstring

Description of the bundle, human readable

versionstring required

Version id for this bundle format

Example request

{
  "blacklisted_images": [
    {
      "registry": "registry",
      "image": {
        "type": "tag",
        "value": "value"
      },
      "name": "name",
      "id": "id",
      "repository": "repository"
    },
    {
      "registry": "registry",
      "image": {
        "type": "tag",
        "value": "value"
      },
      "name": "name",
      "id": "id",
      "repository": "repository"
    }
  ],
  "mappings": [
    {
      "whitelist_ids": [
        "whitelist_ids",
        "whitelist_ids"
      ],
      "registry": "registry",
      "image": {
        "type": "tag",
        "value": "value"
      },
      "policy_id": "policy_id",
      "name": "name",
      "id": "id",
      "policy_ids": [
        "policy_ids",
        "policy_ids"
      ],
      "repository": "repository"
    },
    {
      "whitelist_ids": [
        "whitelist_ids",
        "whitelist_ids"
      ],
      "registry": "registry",
      "image": {
        "type": "tag",
        "value": "value"
      },
      "policy_id": "policy_id",
      "name": "name",
      "id": "id",
      "policy_ids": [
        "policy_ids",
        "policy_ids"
      ],
      "repository": "repository"
    }
  ],
  "whitelists": [
    {
      "name": "name",
      "comment": "comment",
      "id": "id",
      "version": "version",
      "items": [
        {
          "trigger_id": "trigger_id",
          "expires_on": "2000-01-23T04:56:07.000+00:00",
          "id": "id",
          "gate": "gate"
        },
        {
          "trigger_id": "trigger_id",
          "expires_on": "2000-01-23T04:56:07.000+00:00",
          "id": "id",
          "gate": "gate"
        }
      ]
    },
    {
      "name": "name",
      "comment": "comment",
      "id": "id",
      "version": "version",
      "items": [
        {
          "trigger_id": "trigger_id",
          "expires_on": "2000-01-23T04:56:07.000+00:00",
          "id": "id",
          "gate": "gate"
        },
        {
          "trigger_id": "trigger_id",
          "expires_on": "2000-01-23T04:56:07.000+00:00",
          "id": "id",
          "gate": "gate"
        }
      ]
    }
  ],
  "name": "name",
  "policies": [
    {
      "name": "name",
      "comment": "comment",
      "rules": [
        {
          "action": "GO",
          "id": "id",
          "gate": "gate",
          "trigger": "trigger",
          "params": [
            {
              "name": "name",
              "value": "value"
            },
            {
              "name": "name",
              "value": "value"
            }
          ]
        },
        {
          "action": "GO",
          "id": "id",
          "gate": "gate",
          "trigger": "trigger",
          "params": [
            {
              "name": "name",
              "value": "value"
            },
            {
              "name": "name",
              "value": "value"
            }
          ]
        }
      ],
      "id": "id",
      "version": "version"
    },
    {
      "name": "name",
      "comment": "comment",
      "rules": [
        {
          "action": "GO",
          "id": "id",
          "gate": "gate",
          "trigger": "trigger",
          "params": [
            {
              "name": "name",
              "value": "value"
            },
            {
              "name": "name",
              "value": "value"
            }
          ]
        },
        {
          "action": "GO",
          "id": "id",
          "gate": "gate",
          "trigger": "trigger",
          "params": [
            {
              "name": "name",
              "value": "value"
            },
            {
              "name": "name",
              "value": "value"
            }
          ]
        }
      ],
      "id": "id",
      "version": "version"
    }
  ],
  "whitelisted_images": [
    {
      "registry": "registry",
      "image": {
        "type": "tag",
        "value": "value"
      },
      "name": "name",
      "id": "id",
      "repository": "repository"
    },
    {
      "registry": "registry",
      "image": {
        "type": "tag",
        "value": "value"
      },
      "name": "name",
      "id": "id",
      "repository": "repository"
    }
  ],
  "comment": "comment",
  "id": "id",
  "version": "version"
}

Response

Saved bundle

created_atstring date-time
last_updatedstring date-time
policyIdstring

The bundle's identifier

activeboolean

True if the bundle is currently defined to be used automatically

userIdstring

UserId of the user that owns the bundle

policy_sourcestring

Source location of where the policy bundle originated

Example response

{
  "policybundle": {
    "blacklisted_images": [
      {
        "registry": "registry",
        "image": {
          "type": "tag",
          "value": "value"
        },
        "name": "name",
        "id": "id",
        "repository": "repository"
      },
      {
        "registry": "registry",
        "image": {
          "type": "tag",
          "value": "value"
        },
        "name": "name",
        "id": "id",
        "repository": "repository"
      }
    ],
    "mappings": [
      {
        "whitelist_ids": [
          "whitelist_ids",
          "whitelist_ids"
        ],
        "registry": "registry",
        "image": {
          "type": "tag",
          "value": "value"
        },
        "policy_id": "policy_id",
        "name": "name",
        "id": "id",
        "policy_ids": [
          "policy_ids",
          "policy_ids"
        ],
        "repository": "repository"
      },
      {
        "whitelist_ids": [
          "whitelist_ids",
          "whitelist_ids"
        ],
        "registry": "registry",
        "image": {
          "type": "tag",
          "value": "value"
        },
        "policy_id": "policy_id",
        "name": "name",
        "id": "id",
        "policy_ids": [
          "policy_ids",
          "policy_ids"
        ],
        "repository": "repository"
      }
    ],
    "whitelists": [
      {
        "name": "name",
        "comment": "comment",
        "id": "id",
        "version": "version",
        "items": [
          {
            "trigger_id": "trigger_id",
            "expires_on": "2000-01-23T04:56:07.000+00:00",
            "id": "id",
            "gate": "gate"
          },
          {
            "trigger_id": "trigger_id",
            "expires_on": "2000-01-23T04:56:07.000+00:00",
            "id": "id",
            "gate": "gate"
          }
        ]
      },
      {
        "name": "name",
        "comment": "comment",
        "id": "id",
        "version": "version",
        "items": [
          {
            "trigger_id": "trigger_id",
            "expires_on": "2000-01-23T04:56:07.000+00:00",
            "id": "id",
            "gate": "gate"
          },
          {
            "trigger_id": "trigger_id",
            "expires_on": "2000-01-23T04:56:07.000+00:00",
            "id": "id",
            "gate": "gate"
          }
        ]
      }
    ],
    "name": "name",
    "policies": [
      {
        "name": "name",
        "comment": "comment",
        "rules": [
          {
            "action": "GO",
            "id": "id",
            "gate": "gate",
            "trigger": "trigger",
            "params": [
              {
                "name": "name",
                "value": "value"
              },
              {
                "name": "name",
                "value": "value"
              }
            ]
          },
          {
            "action": "GO",
            "id": "id",
            "gate": "gate",
            "trigger": "trigger",
            "params": [
              {
                "name": "name",
                "value": "value"
              },
              {
                "name": "name",
                "value": "value"
              }
            ]
          }
        ],
        "id": "id",
        "version": "version"
      },
      {
        "name": "name",
        "comment": "comment",
        "rules": [
          {
            "action": "GO",
            "id": "id",
            "gate": "gate",
            "trigger": "trigger",
            "params": [
              {
                "name": "name",
                "value": "value"
              },
              {
                "name": "name",
                "value": "value"
              }
            ]
          },
          {
            "action": "GO",
            "id": "id",
            "gate": "gate",
            "trigger": "trigger",
            "params": [
              {
                "name": "name",
                "value": "value"
              },
              {
                "name": "name",
                "value": "value"
              }
            ]
          }
        ],
        "id": "id",
        "version": "version"
      }
    ],
    "whitelisted_images": [
      {
        "registry": "registry",
        "image": {
          "type": "tag",
          "value": "value"
        },
        "name": "name",
        "id": "id",
        "repository": "repository"
      },
      {
        "registry": "registry",
        "image": {
          "type": "tag",
          "value": "value"
        },
        "name": "name",
        "id": "id",
        "repository": "repository"
      }
    ],
    "comment": "comment",
    "id": "id",
    "version": "version"
  },
  "policy_source": "policy_source",
  "last_updated": "2000-01-23T04:56:07.000+00:00",
  "policyId": "policyId",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "active": true,
  "userId": "userId"
}