Entity hook

List entity hook actions

Changed on

Lists entity hook actions within an organization.

get/entity_hook/action

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/entity_hook/action
  • Auth
    HTTP bearer

Query parameters

nrnstring required

Filters actions that match or are more specific than the provided NRN.

entitystring

The type of entity affected by this entity hook action.

on'create' | 'update' | 'delete'

Specifies the type of action that triggers the hook.

Response

The list of entity hooks matching the query.

Example response

{
  "paging": {
    "limit": 200
  },
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "nrn": "organization=1:account=2:namespace=3:application=4",
      "entity": "scope",
      "action": "scope:create",
      "dimensions": {
        "environment": "production",
        "country": "us"
      },
      "on_policy_success": "manual",
      "on_policy_fail": "manual",
      "when": "before",
      "type": "hook",
      "on": "create",
      "policies": [
        {
          "id": 5678,
          "nrn": "organization=1:account=2:namespace=3:application=4",
          "name": "Crypto Kong Policies",
          "conditions": {
            "scope.requested_spec.memory_in_gb": {
              "$lte": 4
            }
          }
        }
      ]
    }
  ]
}

Changes

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • 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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status