REST services
The IBM Security Key Lifecycle Manager Representational State Transfer (REST) API provides access to the IBM Security Key Lifecycle Manager server functions. You can use HTTP methods to implement the REST architecture-based REST services.
Request format
The IBM Security Key Lifecycle Manager REST API
request consists of the following parts:
- URL
- The URL that hosts the RESTful web service.
- HTTP method
- The REST API uses the following HTTP methods to run various actions
on IBM Security Key Lifecycle Manager resources:
- GET
- Lists the specified resource or collection of resources.
- POST
- Creates the specified resource.
- PUT
- Updates or replaces the specified resource.
- DELETE
- Removes the specified resource.
- Request header
- The attributes that describe the request to set up the response format.
- Request body
- More information that is used to process the request. You must pass parameters as JSON (JavaScript Object Notation) object in the request body.
Response format
The REST API service IBM Security Key Lifecycle Manager supports
the JSON response format. The RESTful web service responses contain
two main components:
- Response header
- A list of attributes that describes the response format, and includes an HTTP response code.
- Response body
- The data that represents the resource that you requested or an error message.
Notes:
- For an IBM Security Key Lifecycle Manager REST request message, if you pass duplicate parameters in a JSON request body, the last repeated parameter is processed by the server.
- For an IBM Security Key Lifecycle Manager REST request message, if you pass duplicate parameters as query parameters in the URL, the first repeated parameter is processed by the server.
- All references to the alias property of cryptographic keys and certificates in the graphical user interface, command-line interface, and REST interface will be deprecated in the later versions of IBM Security Key Lifecycle Manager.