Using the API

The IBM® NS1 Connect® API is a standard REST API with JSON responses.

Built with an API-first architecture, the NS1 Connect platform provides all the tools necessary for you to manage your NS1 Connect account and resources programmatically. Refer to the NS1 Connect API documentation for the full index of API endpoints and requests.

HTTP request methods

The HTTP request method that you use determines the type of action that the API takes. Generally, in the case of PUT and POST requests, you send a JSON body in the request with details about the resource that you're creating or updating.

GET: This method requests a representation of the specified resource. Requests that use GET retrieve some specified data set.
PUT: This method submits an entity to the specified resource, which typically is creating a new object.
POST: This method replaces all current representations of the target resource with the request payload. In other words, it edits or updates an existing resource.
DELETE: This method deletes the specified resource or configuration.

Authentication

The NS1 Connect API uses API keys to authenticate requests. You can create your first API key through the NS1 Connect UI with the necessary permissions.

Attention: Do not share your API key secret with anyone, and be sure to store the key secret securely. When you create the API key, enable only the permissions that are required for its intended application.

In the API documentation, "X-NSONE-Key: $NSONE_API_KEY" represents the API authentication header where $NSONE_API_KEY is a valid NS1 Connect API key secret. You can add the API key as one of your environment variables to make it easier to copy and paste code snippets.

Note: NS1 Connect API requests must be made over HTTPS. Unauthenticated API calls and those made over plain HTTP will fail.