NSX-T Data Center REST API

Associated URIs:

API Description API Path

List Dynamic Runbook Instances


List Online Diagnostic System Dynamic Runbooks Instances.
GET /policy/api/v1/infra/sha/dynamic-runbook-instances

Delete the Dynamic Runbook Instance


DELETE /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}

Read a Dynamic Runbook Instance


Read Online Diagnostic System Dynamic Runbook Instance.
GET /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}

Create or update a Dynamic Runbook Instance


Create an Online Diagnostic System Dynamic Runbook Instance with the specified identifier
if not existed, or update an existing Online Diagnostic System Dynamic Runbook Instance
otherwise.
PATCH /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}

Create a Dynamic Runbook Instance


Create an Online Diagnostic System Dynamic Runbook Instance with the specified identifier
POST /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}

Uninstall the Dynamic Runbook package from the instance


DELETE /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}/file

Install the Dynamic Runbook package. Please specify the header "Content-Type: application/octet-stream" in the http request.


POST /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}/file

Remedy the Dynamic Runbook installation


POST /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}/file/action/remedy

Read a Dynamic Runbook Instance state


Read Online Diagnostic System Dynamic Runbook Instance state
GET /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}/state

List Dynamic Runbooks


List Online Diagnostic System Dynamic Runbooks.
GET /policy/api/v1/infra/sha/dynamic-runbooks

Read a Dynamic Runbook


Read Online Diagnostic System Dynamic Runbook.
GET /policy/api/v1/infra/sha/dynamic-runbooks/{runbook-id}

Read help information of a Dynamic Runbook


Read help information of an Online Diagnostic System Dynamic Runbook.
GET /policy/api/v1/infra/sha/dynamic-runbooks/{runbook-id}/help

List Predefined Runbooks


List Online Diagnostic System Predefined Runbooks.
GET /policy/api/v1/infra/sha/pre-defined-runbooks

Read a Predefined Runbook


Read Online Diagnostic System Predefined Runbook.
GET /policy/api/v1/infra/sha/pre-defined-runbooks/{runbook-id}

Read help information of a Predefined Runbook


Read help information of an Online Diagnostic System Predefined runbook.
GET /policy/api/v1/infra/sha/pre-defined-runbooks/{runbook-id}/help

List runbook invocation artifacts


Get a paginated list of Online Diagnostic System Runbook invocation artifacts.
GET /policy/api/v1/infra/sha/runbook-artifacts

Delete a runbook invocation artifact batch request


Delete an Online Diagnostic System Runbook invocation batch request.
DELETE /policy/api/v1/infra/sha/runbook-artifacts/{request-id}

Read the status of a runbook invocation batch request


Read the status of a runbook invocation batch request.
GET /policy/api/v1/infra/sha/runbook-artifacts/{request-id}

Create request to collect artifacts generated by an Online Diagnostic System runbook invocations


Create request to collect the artifacts generated by Online Diagnostic System runbook invocations in a batch.
PATCH /policy/api/v1/infra/sha/runbook-artifacts/{request-id}

Create request to collect artifacts generated by an Online Diagnostic System runbook invocations


Create request to collect the artifacts generated by Online Diagnostic System runbook invocations in a batch.
PUT /policy/api/v1/infra/sha/runbook-artifacts/{request-id}

Download the collection of artifacts generated by an Online Diagnostic System runbook invocations


Download the collection of artifacts generated by an Online Diagnostic System runbook invocations.
Please add the below header in the http request, if it is not present
Accept application/octet-stream
GET /policy/api/v1/infra/sha/runbook-artifacts/{request-id}/artifact

List runbook invocations


Get a paginated list of Online Diagnostic System Runbook invocation entities.
GET /policy/api/v1/infra/sha/runbook-invocations

Delete a runbook invocation


Delete an Online Diagnostic System Runbook invocation with the specified identifier.
DELETE /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}

Read a runbook invocation


Read an Online Diagnostic System Runbook invocation with the specified identifier.
GET /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}

Create a runbook invocation


Create an Online Diagnostic System Runbook invocation. If an invocation with
already exists, throw an exception. Otherwise, create a new
runbook invocation.
A runbook invocation along with its report and status will be deleted automatically
after 2 hours, if it is not deleted by delete API.
POST /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}

Download the artifacts generated by an Online Diagnostic System Runbook invocation


Download the artifacts generated by an Online Diagnostic System Runbook invocation.
Please add the below header in the http request, if it is not present
"Accept: application/octet-stream"
GET /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}/artifact

Read the report of a runbook invocation


Read the report of an Online Diagnostic System Runbook invocation.
GET /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}/report

List runbook settings


Get a paginated list of Online Diagnostic System Runbook setting entities.
GET /policy/api/v1/infra/sha/runbook-settings

Delete a runbook setting


Delete an Online Diagnostic System Runbook setting with the specified identifier.
DELETE /policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}

Read a runbook setting


Read an Online Diagnostic System Runbook setting with the specified identifier.
GET /policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}

Create or update a runbook setting


Create an Online Diagnostic System Runbook setting with the specified identifier
if not existed, update an existing Online Diagnostic System runbook profile otherwise.
PATCH /policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}

Create a runbook setting


Create an Online Diagnostic System Runbook setting with the specified identifier
PUT /policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}