# Reference

Every call in the SparkLogs REST API, grouped by resource, with its method, path and what it does.

[OpenAPI 3.1 file](https://sparklogs.com/api/openapi.json)

## Workspace

- `GET /workspaces/{workspace_id}` [Read a workspace](https://sparklogs.com/docs/api/reference/workspaces.md#read-workspace)
- `PATCH /workspaces/{workspace_id}` [Update a workspace](https://sparklogs.com/docs/api/reference/workspaces.md#update-workspace)
- `PATCH /workspaces/{workspace_id}/onboarding` [Update onboarding](https://sparklogs.com/docs/api/reference/workspaces.md#update-onboarding)
- `PATCH /workspaces/{workspace_id}/ingest-policy` [Update the ingest policy](https://sparklogs.com/docs/api/reference/workspaces.md#update-ingest-policy)
- `GET /regions` [List regions](https://sparklogs.com/docs/api/reference/regions.md#list-regions)
- `GET /workspaces/{workspace_id}/replication-targets` [List replication targets](https://sparklogs.com/docs/api/reference/replication-targets.md#list-replication-targets)

## Organizations and devices

- `GET /workspaces/{workspace_id}/organizations` [List organizations](https://sparklogs.com/docs/api/reference/organizations.md#list-organizations)
- `GET /workspaces/{workspace_id}/organizations/{id}` [Read an organization](https://sparklogs.com/docs/api/reference/organizations.md#read-organization)
- `POST /workspaces/{workspace_id}/organizations` [Create an organization](https://sparklogs.com/docs/api/reference/organizations.md#create-organization)
- `PATCH /workspaces/{workspace_id}/organizations/{id}` [Update an organization](https://sparklogs.com/docs/api/reference/organizations.md#update-organization)
- `DELETE /workspaces/{workspace_id}/organizations/{id}` [Delete an organization](https://sparklogs.com/docs/api/reference/organizations.md#delete-organization)
- `POST /workspaces/{workspace_id}/organizations/{id}/restore` [Restore a deleted organization](https://sparklogs.com/docs/api/reference/organizations.md#restore-organization)
- `POST /workspaces/{workspace_id}/organizations/client-id-check` [Check a client id](https://sparklogs.com/docs/api/reference/organizations.md#check-client-id)
- `POST /workspaces/{workspace_id}/organizations/{id}/move` [Move an organization](https://sparklogs.com/docs/api/reference/organizations.md#move-organization)
- `GET /workspaces/{workspace_id}/agents` [List agents](https://sparklogs.com/docs/api/reference/agents.md#list-agents)
- `GET /workspaces/{workspace_id}/agents/{id}` [Read an agent](https://sparklogs.com/docs/api/reference/agents.md#read-agent)
- `GET /workspaces/{workspace_id}/agents/summary` [Count agents](https://sparklogs.com/docs/api/reference/agents.md#read-agent-summary)
- `PATCH /workspaces/{workspace_id}/agents/{id}` [Update an agent](https://sparklogs.com/docs/api/reference/agents.md#update-agent)
- `DELETE /workspaces/{workspace_id}/agents/{id}` [Delete an agent](https://sparklogs.com/docs/api/reference/agents.md#delete-agent)
- `POST /workspaces/{workspace_id}/agents/{id}/restore` [Restore a deleted agent](https://sparklogs.com/docs/api/reference/agents.md#restore-agent)
- `POST /workspaces/{workspace_id}/agents/{id}/move` [Move an agent](https://sparklogs.com/docs/api/reference/agents.md#move-agent)
- `GET /workspaces/{workspace_id}/agent-release` [Read the agent release](https://sparklogs.com/docs/api/reference/agent-releases.md#read-agent-release)
- `GET /workspaces/{workspace_id}/ingest-keys` [List ingest keys](https://sparklogs.com/docs/api/reference/ingest-keys.md#list-ingest-keys)
- `GET /workspaces/{workspace_id}/ingest-keys/{id}` [Read an ingest key](https://sparklogs.com/docs/api/reference/ingest-keys.md#read-ingest-key)
- `POST /workspaces/{workspace_id}/ingest-keys` [Create an ingest key](https://sparklogs.com/docs/api/reference/ingest-keys.md#create-ingest-key)
- `PATCH /workspaces/{workspace_id}/ingest-keys/{id}` [Update an ingest key](https://sparklogs.com/docs/api/reference/ingest-keys.md#update-ingest-key)
- `DELETE /workspaces/{workspace_id}/ingest-keys/{id}` [Delete an ingest key](https://sparklogs.com/docs/api/reference/ingest-keys.md#delete-ingest-key)
- `POST /workspaces/{workspace_id}/ingest-keys/{id}/restore` [Restore a deleted ingest key](https://sparklogs.com/docs/api/reference/ingest-keys.md#restore-ingest-key)
- `POST /workspaces/{workspace_id}/ingest-keys/{id}/move` [Move an ingest key](https://sparklogs.com/docs/api/reference/ingest-keys.md#move-ingest-key)
- `GET /workspaces/{workspace_id}/ingest-keys/{id}/secret` [Read an ingest key's secret](https://sparklogs.com/docs/api/reference/ingest-keys.md#reveal-ingest-key)
- `POST /workspaces/{workspace_id}/ingest-keys/{id}/rotate` [Replace an ingest key's secret](https://sparklogs.com/docs/api/reference/ingest-keys.md#rotate-ingest-key)
- `GET /workspaces/{workspace_id}/registration-tokens` [List registration tokens](https://sparklogs.com/docs/api/reference/registration-tokens.md#list-registration-tokens)
- `GET /workspaces/{workspace_id}/registration-tokens/{id}` [Read a registration token](https://sparklogs.com/docs/api/reference/registration-tokens.md#read-registration-token)
- `POST /workspaces/{workspace_id}/registration-tokens` [Create a registration token](https://sparklogs.com/docs/api/reference/registration-tokens.md#create-registration-token)
- `PATCH /workspaces/{workspace_id}/registration-tokens/{id}` [Update a registration token](https://sparklogs.com/docs/api/reference/registration-tokens.md#update-registration-token)
- `DELETE /workspaces/{workspace_id}/registration-tokens/{id}` [Delete a registration token](https://sparklogs.com/docs/api/reference/registration-tokens.md#delete-registration-token)
- `POST /workspaces/{workspace_id}/registration-tokens/{id}/restore` [Restore a deleted registration token](https://sparklogs.com/docs/api/reference/registration-tokens.md#restore-registration-token)
- `GET /workspaces/{workspace_id}/registration-tokens/{id}/secret` [Read a registration token's secret](https://sparklogs.com/docs/api/reference/registration-tokens.md#reveal-registration-token)
- `POST /workspaces/{workspace_id}/registration-tokens/{id}/revoke` [Revoke a registration token](https://sparklogs.com/docs/api/reference/registration-tokens.md#revoke-registration-token)

## People and access

- `GET /workspaces/{workspace_id}/members` [List members](https://sparklogs.com/docs/api/reference/members.md#list-members)
- `DELETE /workspaces/{workspace_id}/members/{user_id}` [Remove a member](https://sparklogs.com/docs/api/reference/members.md#delete-member)
- `GET /workspaces/{workspace_id}/invitations` [List invitations](https://sparklogs.com/docs/api/reference/invitations.md#list-invitations)
- `POST /workspaces/{workspace_id}/invitations` [Invite a person](https://sparklogs.com/docs/api/reference/invitations.md#create-invitation)
- `DELETE /workspaces/{workspace_id}/invitations/{id}` [Withdraw an invitation](https://sparklogs.com/docs/api/reference/invitations.md#delete-invitation)
- `POST /workspaces/{workspace_id}/invitations/{id}/send` [Send an invitation email](https://sparklogs.com/docs/api/reference/invitations.md#send-invitation)
- `GET /workspaces/{workspace_id}/groups` [List groups](https://sparklogs.com/docs/api/reference/groups.md#list-groups)
- `GET /workspaces/{workspace_id}/groups/{id}` [Read a group](https://sparklogs.com/docs/api/reference/groups.md#read-group)
- `POST /workspaces/{workspace_id}/groups` [Create a group](https://sparklogs.com/docs/api/reference/groups.md#create-group)
- `PATCH /workspaces/{workspace_id}/groups/{id}` [Rename a group](https://sparklogs.com/docs/api/reference/groups.md#update-group)
- `PUT /workspaces/{workspace_id}/groups/{id}/members` [Set a group's members](https://sparklogs.com/docs/api/reference/groups.md#update-group-members)
- `DELETE /workspaces/{workspace_id}/groups/{id}` [Delete a group](https://sparklogs.com/docs/api/reference/groups.md#delete-group)
- `POST /workspaces/{workspace_id}/grants` [Give a grant](https://sparklogs.com/docs/api/reference/grants.md#create-grant)
- `PUT /workspaces/{workspace_id}/grants/{id}` [Replace a grant](https://sparklogs.com/docs/api/reference/grants.md#update-grant)
- `DELETE /workspaces/{workspace_id}/grants/{id}` [Remove a grant](https://sparklogs.com/docs/api/reference/grants.md#delete-grant)
- `POST /workspaces/{workspace_id}/grants/batch` [Change a grantee's grants together](https://sparklogs.com/docs/api/reference/grants.md#change-grants)
- `GET /workspaces/{workspace_id}/roles` [List roles](https://sparklogs.com/docs/api/reference/roles.md#list-roles)
- `GET /workspaces/{workspace_id}/access` [Read your access in a workspace](https://sparklogs.com/docs/api/reference/access.md#read-access)

## Audit

- `GET /workspaces/{workspace_id}/audit-events` [List audit events](https://sparklogs.com/docs/api/reference/audit-events.md#list-audit-events)
- `GET /workspaces/{workspace_id}/audit-events/{id}` [Read an audit event](https://sparklogs.com/docs/api/reference/audit-events.md#read-audit-event)

## Your credential

- `GET /credential` [Read credential metadata](https://sparklogs.com/docs/api/reference/credential.md#read-credential)
- `POST /credential/rotate` [Rotate the credential's secret](https://sparklogs.com/docs/api/reference/credential.md#rotate-credential)
- `GET /users/{user_id}` [Read your profile](https://sparklogs.com/docs/api/reference/users.md#read-user)

Generated from API description a2371a2f39901fa5a0d0585ef2ff6a7474214b64.

---

Source: <https://sparklogs.com/docs/api/reference>
All SparkLogs documentation in Markdown: <https://sparklogs.com/llms.txt>
