Scope

Read a troubleshooting action

Changed on
get/scope/{scopeId}/action/{actionId}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/scope/{scopeId}/action/{actionId}
  • Auth
    HTTP bearer

Path parameters

scopeIdstring required

The ID of the scope.

actionIdstring required

The ID of the troubleshooting action.

Response

The operation was successful.

idstring

The ID of the troubleshooting action.

namestring

The name of the troubleshooting action.

status'pending_approval' | 'pending_approval_denied' | 'pending' | 'executed' | 'cancelled' | 'failed'

The status of the troubleshooting action.

entitystring

The entity that the troubleshooting action is associated with.

entity_idinteger

The ID of the entity that the troubleshooting action is associated with.

parametersobject

The parameters for the troubleshooting action.

messagesstring[]

The messages for the troubleshooting action.

nrnstring

The NRN of the entity that the troubleshooting action is associated with.

created_atstring date-time

The ISO-8601 UTC timestamp of when the troubleshooting action was created.

updated_atstring date-time nullable

The ISO-8601 UTC timestamp of when the troubleshooting action was last updated.

Example response

{
  "id": "5678",
  "name": "instance_kill",
  "parameters": {
    "instance_id": "i-0a1234567890b1234"
  }
}

Changes

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from string to integer for 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