NSX-T Data Center REST API

Associated URIs:

API Description	API Path
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.	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.	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, or update an existing Online Diagnostic System runbook profle otherwise.	PATCH /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, or update an existing Online Diagnostic System runbook profle otherwise.	PUT /policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}