Delete instance

DELhttps://app.shuttleglobal.com/c/api/instances/{instance_id}

Language

Credentials

Secret key

Remember on this device

Kept in this browser tab unless you tick Remember; don't on a shared computer. Use keys from a sandbox account to test without moving money.

Parameters

Path

instance_idrequired

cURL request

curl --request DELETE \
  --url https://app.shuttleglobal.com/c/api/instances/INSTANCE_ID \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>'

const url = 'https://app.shuttleglobal.com/c/api/instances/INSTANCE_ID';
const options = {method: 'DELETE', headers: {Authorization: 'Basic <base64 of SECRET_KEY:>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://app.shuttleglobal.com/c/api/instances/INSTANCE_ID"

headers = {"Authorization": "Basic <base64 of SECRET_KEY:>"}

response = requests.delete(url, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://app.shuttleglobal.com/c/api/instances/INSTANCE_ID', [
  'headers' => [
    'Authorization' => 'Basic <base64 of SECRET_KEY:>',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/instances/INSTANCE_ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic <base64 of SECRET_KEY:>'

response = http.request(request)
puts response.read_body

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/instances/INSTANCE_ID"

  req, _ := http.NewRequest("DELETE", url, nil)

  req.Header.Add("Authorization", "Basic <base64 of SECRET_KEY:>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response

Instance successfully deleted

No response body.

DELETE

/instances/{instance_id}

Mark an instance as INACTIVE. This action cannot be reversed and should be used with extreme caution.

This endpoint will, with immediate effect, mark an instance as INACTIVE. While the instance may exist in the instance list as INACTIVE for up to one year, it will be inaccessible. No further instructions will be issued by the instance (including any instructions to cancel previously issued instructions, or invalidate previously generated third party credentials). Any instructions mid-way through completion will lapse (e.g., an authorized payment not yet captured).

Authorizations

basicAuth

Parameters

Path Parameters

instance_id

required

string

The instance’s ID (cl_...), or the instance_key you gave it.

Responses

204

Instance successfully deleted

401

Unauthorized

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

Example

{
  "code": "UNAUTHORIZED",
  "message": "Unauthorised"
}

404

Instance not found

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

Was this page helpful?