Sign in
Policies

Update policy

Update/replace and existing policy

put/policies/{policyId}

Path parameters

policyIdstring required

Query parameters

activeboolean

Mark policy as active

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

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 request

{
  "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"
}

Response

A list with a single updated policy bundle record

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"
  }
]

Changes

Changed in 2 of the 5 revisions of this API.422

  • 38e5705e0b2122See the full diff
    • ▲

      the policybundle/policies/items/rules/items/params/items/ request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the items/policybundle/policies/items/rules/items/params/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      added the new optional request property policybundle/whitelists/items/items/items/expires_on

      new-optional-request-property

    • ○

      added the optional property items/policybundle/whitelists/items/items/items/expires_on to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 75f483ab10a022See the full diff
    • ▲

      the policybundle/policies/items/rules/items/params/items/ request property type/format changed from object/ to /

      request-property-type-changed

    • ▲

      the items/policybundle/policies/items/rules/items/params/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the request property policybundle/whitelists/items/items/items/expires_on

      request-property-removed

    • ●

      removed the optional property items/policybundle/whitelists/items/items/items/expires_on from the response with the 200 status

      response-optional-property-removed

    This revision also has 75 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog