DigitalOcean
SnapShooter

Agent Servers

List #

URL Parameters

This endpoint does not accept any parameters 
                            GET
                            /v1/agents
                        
                           
curl https://api.snapshooter.com/v1/agents \
    -X GET \
    --header 'Authorization: Bearer API_TOKEN_HERE'
                       
HTTP/2 200
{
  "data": [
    {
      "id": 2,
      "name": "51.208.67.151",
      "created_at": "2022-10-31T18:27:31.000000Z",
      "connected": false
    },
    {
      "id": 1,
      "name": "78.95.244.23",
      "created_at": "2022-10-31T18:27:31.000000Z",
      "connected": false
    }
  ],
  "links": {
  },
  "meta": {
  }
}

Delete #

Parameters

This endpoint does not accept any parameters 
                            DELETE
                            /v1/agents/{agent_id}
                        
                           
curl https://api.snapshooter.com/v1/agents/{agent_id} \
    -X DELETE \
    --header 'Authorization: Bearer API_TOKEN_HERE'
                       
HTTP/2 204
//Empty Response Body

Errors

Agent Setup Tokens

List Setup Tokens #

URL Parameters

This endpoint does not accept any parameters 
                            GET
                            /v1/agents/setup-tokens
                        
                           
curl https://api.snapshooter.com/v1/agents/setup-tokens \
    -X GET \
    --header 'Authorization: Bearer API_TOKEN_HERE'
                       
HTTP/2 200
{
  "data": [
    {
      "id": 1,
      "name": "Test 1",
      "created_at": "2022-10-31T19:03:43.000000Z",
      "last_used_at": null
    },
    {
      "id": 2,
      "name": "Test 2",
      "created_at": "2022-10-31T19:03:43.000000Z",
      "last_used_at": null
    }
  ],
  "links": {
  },
  "meta": {
  }
}

Create Setup Token #

Parameters

string name (optional)

Name to assign for easy identification.
Example: Terraform DigitalOcean Droplets 

                            POST
                            /v1/agents/setup-tokens
                        
                           
curl https://api.snapshooter.com/v1/agents/setup-tokens \
    -X POST \
    --header 'Authorization: Bearer API_TOKEN_HERE' \
                                                                            -d name (optional)="Terraform DigitalOcean Droplets"
                       
HTTP/2 201
{
  "data": {
    "id": 1,
    "name": "Test",
    "created_at": "2022-10-31T19:34:11.000000Z",
    "last_used_at": null,
    "token": "1|mzBr2dNeczhtJpFoCz0fZbNusZ6hS1ZikJVaG5zd"
  }
}

Errors

Revoke Setup Token #

Parameters

This endpoint does not accept any parameters 
                            DELETE
                            /v1/agents/setup-tokens/{token_id}
                        
                           
curl https://api.snapshooter.com/v1/agents/setup-tokens/{token_id} \
    -X DELETE \
    --header 'Authorization: Bearer API_TOKEN_HERE'
                       
HTTP/2 204
//Empty Response Body

Errors

Related

Backup Solutions (Recipes)
Was this page helpful?

Thank you for helping us improve!