Getting started with the IBM Graph API
Refer to the following sections to get started with the IBM® Graph API.
Welcome to the IBM Graph API. This API is designed to streamline your data management and backup monitoring processes, providing IT professionals with robust tools and insights.
Authentication and Authorization
To access the resources of IBM Storage Protect for Cloud by using the IBM Graph API, you must configure the app registration and grant the necessary permissions by using the following steps:
- Registering an app: Set up your app in IBM Storage Protect for Cloud.
- Permissions: Assign the appropriate permissions for your app.
- Authentication: Use the generated application (client) ID for secure access.
For a step-by-step guide on creating an app registration for API authentication, see Register an App for API Access.
Note: For partner operations, go to IBM Storage Protect for Cloud Partners for app registration. See App Registration in IBM Storage Protect for Cloud Partners guide.
Calling an API method
To interact with resources, construct a request as follows:
{HTTP method} https://{dc}-graph.sp4c.storage-defender.ibm.com/{resource}?{query-parameters}
Request components
{HTTP method}: The HTTP method used for the request.{resource}: The referenced resource.{query-parameters}: Optional parameters to customize the response.
Response components
After you make a request, a response is returned that includes:
- Status code: An HTTP status code that indicates success or failure.
- Response message: The data that you requested or the result of the operation. The response message can be empty for some operations.
- nextLink: If your request returns much data, you need to page through it by using the URL returned in nextLink.
- Response headers: Additional information about the response, such as the type of content that is returned and the request-ID that you can use to correlate the response to the request.
HTTP methods
The API uses the HTTP methods to specify the action that is being performed on a request. The API supports the following method:
| Method | Description |
|---|---|
| GET | Read data from a resource. |
| POST | Create data in a resource. |
| DELETE | Delete data from a resource. |
HTTP status code
HTTP status codes indicate the outcome of a request. Common codes include:
| Code | Description |
|---|---|
| 200 | OK – The request was successful, and the response contains the requested data. |
| 400 | Bad Request – The request might not be processed due to invalid parameters. |
| 500 | Internal Server Error – An unexpected server error occurred. |
Resource
A resource can be an entity or complex type, commonly defined with properties. Your URL includes the resource that you are interacting with in the request, such as customers, services, and jobs. Methods can also be used to perform operations on the resources.