vRealize Operations Manager API Programming Guide REST API Workflows Application programs written to use a rEst Apl use Http requests that are often executed by a script or other higher-level language to make remote procedure calls that create, retrieve, update, or delete bjects that the API defines In the vRealize Operations Manager REST API, these objects are defined by a collection of Xml schemas The operations themselves are Http requests and so are generic to Http clients To write a Rest Api client application you must understand only the Http protocol and the semantics of JSoN or XML, the transfer format that the vRealize Operations Manager API uses. To use the API effectively in such a client, you must become familiar with the following concepts The set of objects that the API supports, and what they represent How the API represents these objects How a client refers to an object on which it wants to operate The API reference includes a complete list of API requests. See About the Schema Reference rEalize Operations Manager API REST Requests To retrieve object representations clients make Http requests to object references Security The Http link between an Api client and server is established using Ssl. Api clients configure either basic authentication or token-based authentication to communicate with the server. If token-based authentication is used, the API client must complete a login request to receive an authentication token that is included in all subsequent requests Figure 2-2. Scenario: Provide user credentials to obtain details about alert with ID 123 REST API REST API AuthN Alert Client Service Backend GET lapi/alerts/123 Extract Auth Header User x with valid session getAlertDetails(123) 200 OK Alert DataREST API Workflows Application programs written to use a REST API use HTTP requests that are often executed by a script or other higher-level language to make remote procedure calls that create, retrieve, update, or delete objects that the API defines . In the vRealize Operations Manager REST API, these objects are defined by a collection of XML schemas. The operations themselves are HTTP requests, and so are generic to all HTTP clients. To write a REST API client application, you must understand only the HTTP protocol, and the semantics of JSON or XML, the transfer format that the vRealize Operations Manager API uses. To use the API effectively in such a client, you must become familiar with the following concepts. n The set of objects that the API supports, and what they represent. n How the API represents these objects. n How a client refers to an object on which it wants to operate. The API reference includes a complete list of API requests. See About the Schema Reference. vRealize Operations Manager API REST Requests To retrieve object representations, clients make HTTP requests to object references. Security The HTTP link between an API client and server is established using SSL. API clients configure either basic authentication or token-based authentication to communicate with the server. If token-based authentication is used, the API client must complete a login request to receive an authentication token that is included in all subsequent requests . Figure 2‑2. Scenario: Provide user credentials to obtain details about alert with ID 123 vRealize Operations Manager API Programming Guide VMware, Inc. 7