NSX-T Data Center REST API

Read the status of a runbook invocation batch request

Read the status of a runbook invocation batch request.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sha/runbook-artifacts/{request-id}
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
OdsRunbookInvocationArtifactBatchResult+

Example Response:

{ "status": "FINISHED", "invocation_paths": [ "/infra/sha/runbook-invocations/ink1" ], "is_transient": true, "successful_invocations": { "result_count": 1, "results": [ "/infra/sha/runbook-invocations/ink1" ] }, "failed_invocations": { } }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: