Event

List all notification events.

get/notification/

Request

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

Query parameters

nrnstring required

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

show_descendantsboolean

Whether to include notification events from descendant resources of the provided NRN.

include_resultsboolean

Whether to include results in the response.

sourcestring[]

Filters notification events by their source. You can select one or more sources from the list.

Note: In the Request panel, click and drag or use <kbd>Ctrl</kbd> / <kbd>Cmd</kbd> + click to select multiple sources.

status'pending' | 'success' | 'fail'

Filters notification events by their status.

idstring uuid

Filters notification events by ID. Must be a valid UUID, otherwise the request fails with a 400 error.

created_at:gtestring date-time

Returns events created at or after this ISO 8601 timestamp.

created_at:gtstring date-time

Returns events created after this ISO 8601 timestamp.

created_at:ltestring date-time

Returns events created at or before this ISO 8601 timestamp.

include_contextboolean

Whether to include context in each event of the response.

ℹ️ Note: You need a secops role to use this parameter.

Response

The operation was successful.

Example response

{
  "results": [
    {
      "id": "1180cd02-1c36-4274-8e7a-4483b87e8f2e",
      "nrn": "organization=1:account=2:namespace=3:application=4",
      "source": [
        "approval"
      ],
      "action": "deployment:create",
      "status": "success",
      "created_at": "2024-02-19T12:34:56Z",
      "updated_at": "2024-02-19T12:34:56Z",
      "tags": {
        "approval_id": 1234,
        "scope_slug": "development-uk-123"
      },
      "results": [
        {
          "id": "7c2d9b5e-3f61-4a0e-9d58-1b6a42e7c0f3",
          "notification_id": "1180cd02-1c36-4274-8e7a-4483b87e8f2e",
          "channel_id": 789,
          "status": "success",
          "response": "{\"statusCode\":200}",
          "created_at": "2024-02-19T12:34:56Z",
          "updated_at": "2024-02-19T12:34:56Z"
        }
      ]
    }
  ]
}

Changes

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • 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

    • warning

      added the new checklist enum value to the /// response property for the response status

    • warning

      added the new pending enum value to the // response property for the response status

    • info

      added the new optional query request parameter created_at:gt

    • info

      added the new optional query request parameter created_at:gte

    • info

      added the new optional query request parameter created_at:lte

    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter include_context

    • info

      added the new enum value pending to the query request parameter status

    • info

      added the enum value checklist to the property items/ of the query request parameter source

    • 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

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      removed the action:instance_kill:create enum value from the // response property for the response status

    • info

      removed the application:create enum value from the // response property for the response status

    • info

      removed the audit:log enum value from the // response property for the response status

    • info

      removed the deployment:create enum value from the // response property for the response status

    • info

      removed the deployment:write enum value from the // response property for the response status

    • info

      removed the deployment_group:create enum value from the // response property for the response status

    • info

      removed the grant:create enum value from the // response property for the response status

    • info

      removed the instance:data enum value from the // response property for the response status

    • info

      removed the log:read enum value from the // response property for the response status

    • info

      removed the metric:data enum value from the // response property for the response status

    • info

      removed the metric:list enum value from the // response property for the response status

    • info

      removed the parameter:delete enum value from the // response property for the response status

    • info

      removed the parameter:notify enum value from the // response property for the response status

    • info

      removed the parameter:read-secrets enum value from the // response property for the response status

    • info

      removed the parameter:retrieve enum value from the // response property for the response status

    • info

      removed the parameter:store enum value from the // response property for the response status

    • info

      removed the scope:create enum value from the // response property for the response status

    • info

      removed the scope:delete enum value from the // response property for the response status

    • info

      removed the scope:recreate enum value from the // response property for the response status

    • info

      removed the scope:stop enum value from the // response property for the response status

    • info

      removed the scope:write enum value from the // response property for the response status

    • info

      removed the service:action:create enum value from the // response property for the response status

    • info

      removed the target_group:create enum value from 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

    • 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