OpenAPI Specification
openapi: 3.0.0
info:
contact:
email: hey@slide.tech
name: Slide Team
url: https://docs.slide.tech
description: "## Introduction\nThe Slide API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\n## Authentication\nWe use API tokens to authenticate requests. You can view and manage your API tokens in the [Slide Console](https://docs.slide.tech).\nWhen making HTTP requests, you'll need to include the API token in the `Authorization` header, using Bearer auth (e.g. `Authorization: Bearer YOUR_SECRET_TOKEN`).\n\nExample:\n```shell\n$ curl -H 'Authorization: Bearer YOUR_SECRET_TOKEN' 'https://api.slide.tech/v1/device'\n```\n\n## Pagination\nAll list endpoints support pagination. You can use the `limit` and `offset` query parameters to control the number of items returned and the starting index.\nList responses will include a `pagination` key that includes the `next_offset` to use for pagination.\nIf `next_offset` is not present, that indicates there are no more items to fetch.\n\nExample:\n```shell\n$ curl -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \\\n 'https://api.slide.tech/v1/device?offset=0&limit=10'\n{\n \"pagination\": {\n \"next_offset\": 10\n },\n \"data\": [\n ...\n ]\n}\n```\n\n## Rate Limiting\nWe limit the number of requests you can make to the API within a certain time frame.\nEach API token has a pool of `50` requests. We refill this pool at a rate of `10` requests per second.\nIf you exceed the rate limit, you'll receive a response with a `429 Too Many Requests` HTTP code and a `err_rate_limit_exceeded` error code.\nPlease wait before retrying the request. We recommend you implement an exponential backoff strategy to handle rate limits.\n\n## Errors\nSlide uses conventional HTTP response codes to indicate the success or failure of an API request.\nIn 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), and codes in the 5xx range indicate an error with Slide's servers.\n\nWe also include [error codes and details](#model/error) in the response, which may provide more context about the error.\n\nExample:\n```shell\n$ curl 'https://api.slide.tech/v1/device'\n{\n \"codes\": [\n \"err_missing_authentication\"\n ],\n \"details\": [\n ...\n ],\n \"message\": \"unauthorized\"\n}\n```\n\nSome common error codes are:\n\n| Code | Description |\n|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `err_endpoint_not_found` | Requested endpoint does not exist. |\n| `err_entity_not_found` | Requested entity does not exist. |\n| `err_validation_error` | Bad request due to validation error. The error `details` will contain any fields that were not valid. |\n| `err_missing_authentication` | Unauthorized due to missing API token. See [authentication](#description/authentication) for more details. |\n| `err_unauthorized` | Unauthorized due to invalid API token. You've provided an invalid API token or the API token does not have permission to access the requested resource. |\n| `err_internal_server_error` | Something went wrong. If you retry the request and it does not succeed, you may contact us at `hey@slide.tech`. |\n| `err_rate_limit_exceeded` | Rate limit exceeded. Please wait before retrying the request. See [rate limiting](#description/rate-limiting) for more details. |\n\n<details>\n <summary>Show more error codes.</summary>\n\n| Code | Description |\n|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------|\n| `err_agent_not_connected_to_device` | Agent is not connected to the device. Ensure the agent is powered on and has network connectivity. |\n| `err_device_not_connected_to_cloud` | Device is not connected to the cloud. Ensure the device is powered on and has network connectivity. |\n| `err_backup_already_running` | A backup is already running for this agent. Please wait for the current backup to complete before starting a new one. |\n| `err_client_not_found` | Client not found. Ensure the client ID is valid and the client exists. |\n\n</details>\n\n## Eventual Consistency\n\nSlide operates an eventual consistency model, where data may not be immediately available after an operation.\nThis is due to the distributed nature of our system and the need for replication and synchronization across multiple\nsystems. Users should expect that operations may take a short period of time to propagate and become visible to all\ncomponents of the system.\n\n## Deprecations and Breaking Changes\n\n### Active Deprecations\n\n`Device.ip_addresses` and `Agent.ip_addresses` will be removed. They have been replaced by `Device.addresses` and `Agent.addresses` respectively.\n"
title: Slide Accounts Backups API
version: 1.34.0
servers:
- url: https://api.slide.tech
security:
- BearerAuth: []
tags:
- description: Everything about [backups](#model/backup)
name: Backups
paths:
/v1/backup:
get:
description: 'Returns a paginated list of backups.
Backup record history details:
- The last 10 backups will always be available.
- Successful backups are removed when the related snapshot is removed.
- Unsuccessful backups older than 30 days are removed.'
operationId: Backups
parameters:
- $ref: '#/components/parameters/QueryAgentID'
- $ref: '#/components/parameters/QuerySnapshotID'
- $ref: '#/components/parameters/QueryDeviceID'
- $ref: '#/components/parameters/QueryOffset'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryBackupStartedAfter'
- $ref: '#/components/parameters/QueryBackupStartedBefore'
- $ref: '#/components/parameters/QueryBackupEndedAfter'
- $ref: '#/components/parameters/QueryBackupEndedBefore'
- description: Sort by a specific field
in: query
name: sort_by
schema:
default: start_time
enum:
- id
- start_time
type: string
- $ref: '#/components/parameters/QuerySortAsc'
responses:
'200':
content:
application/json:
schema:
description: Paginated response
properties:
data:
description: List of backups
items:
$ref: '#/components/schemas/Backup'
title: Backups
type: array
pagination:
$ref: '#/components/schemas/Pagination'
required:
- pagination
- data
title: Paginated response
type: object
description: OK
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'500':
$ref: '#/components/responses/500'
summary: List backups
tags:
- Backups
post:
operationId: BackupStart
requestBody:
content:
application/json:
example: "{\n \"agent_id\": \"a_0123456789ab\"\n}"
schema:
properties:
agent_id:
$ref: '#/components/schemas/AgentID'
required:
- agent_id
required: true
responses:
'202':
content:
application/json:
schema:
properties:
backup_id:
$ref: '#/components/schemas/BackupID'
required:
- backup_id
description: Accepted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
summary: Start backup
tags:
- Backups
/v1/backup/{backup_id}:
get:
operationId: BackupByID
parameters:
- $ref: '#/components/parameters/PathBackupID'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Backup'
description: OK
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
summary: Get backup
tags:
- Backups
components:
schemas:
DeviceID:
description: ID of a device
example: d_0123456789ab
pattern: ^d_[a-z0-9]{12}$
type: string
SnapshotID:
description: ID of a snapshot
example: s_0123456789ab
pattern: ^s_[a-z0-9]{12}$
type: string
Pagination:
properties:
next_offset:
description: Next offset to use for pagination. If this field is not present, that indicates there are no more items to fetch.
example: 10
format: uint32
type: integer
type: object
BackupID:
description: ID of a backup attempt
example: b_0123456789ab
pattern: ^b_[a-z0-9]{12}$
type: string
Error:
description: Error response object that represents an error that occurred during a request.
properties:
codes:
description: List of error codes that occurred during a request.
items:
description: A unique error code that identifies the error.
title: Code
type: string
title: Codes
type: array
details:
description: List of error details that occurred during a request. This may contain action(s) that need to be taken before retrying the request.
items:
description: Short detail message describing the error.
title: Detail
type: string
title: Details
type: array
message:
description: Short message describing the error.
title: Message
type: string
required:
- codes
- message
- details
AgentID:
description: ID of an agent
example: a_0123456789ab
pattern: ^a_[a-z0-9]{12}$
type: string
Backup:
description: Backup object that represents a backup attempt that may have succeeded or failed.
properties:
agent_id:
$ref: '#/components/schemas/AgentID'
backup_id:
$ref: '#/components/schemas/BackupID'
ended_at:
description: End time of the backup
example: '2024-08-23T01:40:08Z'
format: date-time
type: string
error_code:
description: Error code of the backup
externalDocs:
description: See our console documentation for more information on backup error codes
url: https://docs.slide.tech/backups/#common-errors
format: uint32
type: integer
error_message:
description: Human readable error message
type: string
snapshot_id:
description: ID of the snapshot taken as part of the backup. If this field is not present, that indicates a snapshot was not taken.
example: s_0123456789ab
pattern: ^s_[a-z0-9]{12}$
type: string
started_at:
description: Start time of the backup
example: '2024-08-23T01:25:08Z'
format: date-time
type: string
status:
description: Status of the backup
enum:
- created
- pending
- started
- preflight
- contacting
- creating_vss
- preparing
- transferring
- snapshot
- finalizing
- canceling
- failing
- canceled
- failed
- succeeded
example: succeeded
type: string
required:
- backup_id
- agent_id
- started_at
- status
type: object
parameters:
QueryBackupEndedBefore:
description: Filter snapshots completed before a specific backup end time (RFC3339 format)
in: query
name: backup_ended_before
schema:
format: date-time
type: string
QuerySortAsc:
description: Sort in ascending order
in: query
name: sort_asc
schema:
default: false
type: boolean
QueryAgentID:
in: query
name: agent_id
schema:
$ref: '#/components/schemas/AgentID'
QueryBackupStartedBefore:
description: Filter snapshots created before a specific backup start time (RFC3339 format)
in: query
name: backup_started_before
schema:
format: date-time
type: string
PathBackupID:
example: b_0123456789ab
in: path
name: backup_id
required: true
schema:
$ref: '#/components/schemas/BackupID'
QueryDeviceID:
in: query
name: device_id
schema:
$ref: '#/components/schemas/DeviceID'
QueryBackupEndedAfter:
description: Filter snapshots completed after a specific backup end time (RFC3339 format)
in: query
name: backup_ended_after
schema:
format: date-time
type: string
QueryOffset:
description: Starting index for pagination
in: query
name: offset
schema:
default: 0
format: uint32
minimum: 0
type: integer
QueryBackupStartedAfter:
description: Filter snapshots created after a specific backup start time (RFC3339 format)
in: query
name: backup_started_after
schema:
format: date-time
type: string
QueryLimit:
description: Number of items to return for pagination
in: query
name: limit
schema:
default: 10
format: uint32
maximum: 50
minimum: 1
type: integer
QuerySnapshotID:
in: query
name: snapshot_id
schema:
$ref: '#/components/schemas/SnapshotID'
responses:
'400':
content:
application/json:
examples:
err_validation_error:
summary: Validation error
value:
codes:
- err_validation_error
details:
- 'parameter "device_id" in path has an error: string doesn''t match the regular expression "^d_[a-z0-9]{12}$"'
message: bad request
schema:
$ref: '#/components/schemas/Error'
description: Bad request
'401':
content:
application/json:
examples:
err_missing_authentication:
summary: Missing API token
value:
codes:
- err_missing_authentication
details:
- 'You did not provide an API token. You need to provide your API token in the Authorization header, using Bearer auth (e.g. ''Authorization: Bearer YOUR_SECRET_TOKEN'').'
message: unauthorized
err_unauthorized:
summary: Invalid API token
value:
codes:
- err_unauthorized
details:
- Invalid API token provided or you do not have permission to access this resource.
message: unauthorized
schema:
$ref: '#/components/schemas/Error'
description: Unauthorized
'500':
content:
application/json:
examples:
err_internal_server_error:
summary: Internal server error
value:
codes:
- err_internal_server_error
details:
- Something went wrong processing your request. See https://docs.slide.tech/api/#description/errors for more information.
message: internal server error
schema:
$ref: '#/components/schemas/Error'
description: Internal server error
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Conflict
securitySchemes:
BearerAuth:
bearerFormat: string
scheme: bearer
type: http