Skip to main content

​
Getting started with curl

1

Install curl if it isn't already installed on your machine

To check if curl is installed, execute curl --version in the command line. If the output is information about the version of curl, it is installed. If you get a message similar to command not found: curl, you need to download and install curl. For more information, see the curl project download page
2

Create a Tenant API key

Create a Tenant API key accessing Tenant API Keys dashboard
API Key

Go to Settings > API Keys


API Name

Add a API Key name and Create API Key

Treat your API key like a password. Do not store it as plain text or expose it in any code base.
3

Use the curl command to make your request

Pass your API key in an Authorization header. Replace {PLERION_API_KEY} with your API key.
export PLERION_API_URL={region}.api.plerion.com
export PLERION_API_KEY=PLERION_API_KEY

curl --request GET \
        --url "https://$PLERION_API_URL/v1/tenant/findings" \
                --header "Authorization: Bearer $PLERION_API_KEY"

​
Overview

Plerion API uses API keys to authenticate requests. You can view and manage your API keys in the Tenant API Keys dashboard. API responses are JSON-encoded.

​
Authentication

To authenticate to Plerion API send the API Key using bearer auth in the Authorization header. Authorization: Bearer $PLERION_API_KEY All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

​
Errors

Plerion uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g. a required parameter was omitted). Codes in the 5xx range indicate an error with Plerion’s servers. Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported. Detailed description for the status code can be found in the Response Status Codes section.

​
Response Status Codes

The Plerion API endpoints return the following HTTP response status codes.
Status CodeDefinitionDescription
200OKThe request has succeeded.
201CreatedThe request has been fulfilled and resulted in a new resource being created.
204No ContentThe server has fulfilled the request but does not need to return an entity-body.
400Bad RequestThe request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
401UnauthorizedThe request requires user authentication. If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials.
403ForbiddenThe server understood the request, but is refusing to fulfill it. Authorization will not fix the issue and the request SHOULD NOT be repeated.
404Not FoundThe server has not found anything matching the Request-URI.
405Method Not AllowedThe method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
409ConflictThe request could not be completed due to a conflict with the current state of the resource.
429Too Many RequestsToo many requests occurred during the allotted time period and rate limiting was applied.
500Internal Server ErrorThe request did not complete due to an internal error on the server side. The server encountered an unexpected condition which prevented it from fulfilling the request.
503Service UnavailableThe server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
⌘I