Sign in
Entity hook

Create an entity hook action

Create an action for an entity hook.

post/entity_hook/action

Request body

nrnstring required

A resource identifier (NRN) specifying where this action applies.

entity'application' | 'scope' | 'deployment' | 'namespace' required

The type of entity affected by this entity hook action.

action'deployment:create' | 'deployment:write' | 'deployment:delete' | 'scope:create' | 'scope:write' | 'scope:delete' | 'application:create' | 'application:write' | 'application:delete' | 'namespace:create' | 'namespace:write' | 'namespace:delete' required

The specific action you want to be notified about.

dimensionsobject

Key-value pairs defining the scope of the action.

when'before' | 'after' required

Specifies whether the hook occurs before or after nullplatform's internal logic.

type'hook' required

The type of entity hook action.

Note: Currently, only "hook" is supported.

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

Specifies the type of action that triggers the hook.

Example request

{
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "entity": "scope",
  "action": "scope:create",
  "dimensions": {
    "environment": "production",
    "country": "us"
  },
  "when": "before",
  "type": "hook",
  "on": "create"
}

Response

The action was triggered successfully.

idstring uuid required

The unique identifier of the entity hook.

nrnstring required

A resource identifier (NRN) specifying where this action applies.

entity'application' | 'scope' | 'deployment' | 'namespace' required

The type of entity affected by this entity hook action.

action'deployment:create' | 'deployment:write' | 'deployment:delete' | 'scope:create' | 'scope:write' | 'scope:delete' | 'application:create' | 'application:write' | 'application:delete' | 'namespace:create' | 'namespace:write' | 'namespace:delete' required

The specific action you want to be notified about.

dimensionsobject

Key-value pairs defining the scope of the action.

on_policy_success'manual' required

The action to be taken on the entity hook success.

Note: Currently, only "manual" is supported.

on_policy_fail'manual' required

The action to be taken on entity hook failure."

Note: Currently, only "manual" is supported.

when'before' | 'after' required

Specifies whether the hook occurs before or after nullplatform's internal logic.

type'hook' required

The type of entity hook action.

Note: Currently, only "hook" is supported.

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

Specifies the type of action that triggers the hook.

Example response

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

No recorded changes to this endpoint across all 1 revision of this API.