⚙️API Docs

Documentation of Sentry's REST API.

Authorization

When interacting with the API, for most requests, you'll need to provde an authorization header. It should look like this:

Authorization: Basic {base64 encoding of: "username:password"}

For example, it may look something like:

Authorization: Basic bmV2ZXJnb25uYTpnaXZleW91dXA=

License Management

License Check

POST /check

Checks the validity of any given license.

Request Body

Name	Type	Description
license*	String	The license ID.
product*	String	The ID of the product that this license is for.

404: Not Found If the license isn't found, or the license isn't for the product id that you provided, you'll recieve an error.

Code: 10

400: Bad Request If you provided any invalid fields.

403: Forbidden If the license has had too many unique IPs connect to it.

200: OK If the license was valid.

500: Internal Server Error If there was an internal server error.

Create License

POST /license

Headers

Name	Type	Description
Authorization*	String	You'll need an authorization header.

Request Body

Name	Type	Description
product*	String	The ID of the product that this license is for.
max_ips	int	Maximum amount of unique IPs that can use this license.
expires	String	How long until this license should expire. In this format: 1d2h3m4s
note	String	You can add an optional note for the license.
owner_id*	String	The ID of the user that owns this license.

404: Not Found If the provided product ID could not be found.

400: Bad Request If you proivded an invalid payload.

200: OK If the license was created successfully.

401: Unauthorized If you provided an invalid username or password.

Product Management

Get Products

GET /products

Retrieves all products.

Headers

Name	Type	Description
Authorization*	String	You'll need an authorization header.

401: Unauthorized If you provided an invalid username or password.

200: OK Returns a JSON array of all products

Get Product

GET /product/{id}

Retrieves a product by its ID.

Path Parameters

Name	Type	Description
id*	String	The product ID

Headers

Name	Type	Description
Authorization*	String	You'll need an authorization header.

400: Bad Request If the product can't be found.

200: OK Returns the product as JSON.

401: Unauthorized If you provided an invalid username or password.

Create Product

POST /products

Creates a product

Headers

Name	Type	Description
Authorization	String	You'll need an authorization header.

Request Body

Name	Type	Description
name*	String	Name of the product.
description*	String	Description of the product

200: OK Created product sucessfully.

400: Bad Request Invalid JSON or invalid or missing values provided.

401: Unauthorized Invalid auth header.

Modify Product

PUT product/{id}

Modifes a product. You must have at least one of the body parameteres, or you'll be given a 400 error. If any of the values are provided as null, they will not be changed.

Path Parameters

Name	Type	Description
id*	String	ID of the product that you want to modify.

Headers

Name	Type	Description
Authorization*	String	You'll need an authorization header.

Request Body

Name	Type	Description
name	String	New name of the product
description	String	New description of the product.

400: Bad Request Either you provided invalid JSON or you didn't provide a valid value to change.

404: Not Found If the product can't be found.

401: Unauthorized If you provided an invalid authorization header or invalid credentials.

200: OK Successfully modified the product.

Delete Product

DELETE /product/{id}

Deletes a product by ID.

Path Parameters

Name	Type	Description
id*	String	The ID of the product that you want to delete.

Headers

Name	Type	Description
Authorization*	String	You'll need an authorization header.

401: Unauthorized If you provided an invalid username or password.

200: OK If the product was deleted successfully.

404: Not Found If the product can not be found.