IRironcladapp
Agents

Retrieve the Status of an Intake Agent Run Job

Changed on

Check the status of an Intake Agent run you started while using the Run Intake Agent route.

OAuth Scope required: public.agents.runIntakeAgent

get/intake-agent/run/{asyncJobId}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/intake-agent/run/{asyncJobId}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.agents.runIntakeAgent

Path parameters

asyncJobIdstring required

The identifier provided in the response of running the Intake Agent asynchronously.

Response

The status of the Intake Agent run.

OR
OR

Example response

{
  "requestPayload": {
    "template": "600b296c3e15a234ab88f884"
  }
}

Changes