Atlos offers a project-scoped API to help investigators integrate with third-party services like mapping and archival applications.
You can learn more about the API authentication scheme and endpoints below. API tokens are only accessible to project owners.
- Navigate to the project for which you need an API token.
- Navigate to the Access page of the project.
- Press the Create button in the API Tokens section of the page.
- Assign the token a name, write a description of what the token is used for, and select permissions for the token.
- Click the Create Token button.
API tokens are sensitive—they allow read and write access to your project.
To authenticate against the API, include an
Authorization header and set its value to
Bearer <your token>.
The Atlos API supports
POST endpoints. All
GET endpoints return 30 results at a time. By default, every API token will have access to a
You can paginate using the
cursor query parameter, whose value is provided by the
previous keys in the response. Results are available under the
GET /api/v2/incidents returns all incidents, with the most recently modified incidents listed first.
GET /api/v2/source_material returns all source material, with the most recently modified source material listed first.
POST /api/v2/add_comment/:slug with string parameter
message adds a comment to the incident with slug
:slug (the slug is the last part of the URL for the incident, and is also available in the
slug field of the incident object).
POST /api/v2/update/:slug/:attribute_name with parameter
value and optional string parameter
message updates the value of
value for the incident with slug
:slug (the slug is the last part of the URL for the incident, and is also available in the ‘slug’ field of the incident object).
message is provided, it will be added as a comment to the incident (as part of the tracked change).
The value of
attribute_name is available in the URL of the incident page when editing the incident.
Core attributes have string names (such as
status) while custom attributes are identified by their UUID.
value must be a string for text-based or single-select attributes, and a list of strings for multi-select attributes.