API reference / Account REST API (/users/current)

Tokens and discovery

Account REST API (/users/current). Generated from the OpenAPI document the services export (/openapi.json).

Samples use the placeholders YOUR_API_KEY and YOUR_ACCOUNT_ID. Paste a sandbox key (twsk_…) to fill them in and to use Try it. It stays in this browser tab and is only sent to the sandbox, never to the live API.

Sandbox key

Sandbox account id

Try it is off in this build: No sandbox URL is configured for this build of the docs.

POST `/users/current/narrow-down-auth-token`

Narrow Down Idempotency-Key Auth: auth-token

Parameters of POST /users/current/narrow-down-auth-token
Parameter	In	Type	Description
`validity-in-hours`	query	`number`
`Idempotency-Key`	header	`string \| null`	Optional; replays the first answer
`X-Actor`	header	`string \| null`	Who is acting (audit log)
`X-Reason`	header	`string \| null`	Why (audit log; percent-encode non-ASCII)

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/users/current/narrow-down-auth-token' \
  -H 'auth-token: YOUR_API_KEY' \
  -H 'Idempotency-Key: my-request-1' \
  -H 'X-Reason: why you are doing this'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/users/current/narrow-down-auth-token",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/users/current/narrow-down-auth-token", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/users/current/regions`

Regions Auth: auth-token

Responses

200 Successful Response · string[]
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/users/current/regions' \
  -H 'auth-token: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/users/current/regions",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/users/current/regions");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/users/current/servers/mt-client-api`

Client Api Domain Auth: auth-token

Responses

200 Successful Response · object
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/users/current/servers/mt-client-api' \
  -H 'auth-token: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/users/current/servers/mt-client-api",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/users/current/servers/mt-client-api");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/users/current/tokens`

List Tokens Auth: auth-token

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/users/current/tokens' \
  -H 'auth-token: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/users/current/tokens",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/users/current/tokens");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/users/current/tokens`

Create Token Idempotency-Key Auth: auth-token

Parameters of POST /users/current/tokens
Parameter	In	Type	Description
`Idempotency-Key`	header	`string \| null`

Request body NewToken required

Request body fields of POST /users/current/tokens
Field	Type	Description
`name`	`string`
`kind`	`"api" \| "account"`
`applications`	`string[] \| null`
`roles`	`string[] \| null`
`accountIds`	`string[] \| null`
`readOnly`	`boolean`
`ttlInHours`	`number \| null`
`ipAllowlist`	`string[] \| null`

Responses

201 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/users/current/tokens' \
  -H 'auth-token: YOUR_API_KEY' \
  -H 'Idempotency-Key: my-request-1' \
  -H 'Content-Type: application/json' \
  -d '{"name":"","kind":"api","readOnly":false}'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/users/current/tokens",
        json={"name": "", "kind": "api", "readOnly": False},
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/users/current/tokens", {
  body: {"name":"","kind":"api","readOnly":false},
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/users/current/tokens/{token_id}`

Get Token Auth: auth-token

Parameters of GET /users/current/tokens/{token_id}
Parameter	In	Type	Description
`token_id` required	path	`string`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/users/current/tokens/TOKEN_ID' \
  -H 'auth-token: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/users/current/tokens/TOKEN_ID",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/users/current/tokens/TOKEN_ID");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

PATCH `/users/current/tokens/{token_id}`

Patch Token Auth: auth-token

Parameters of PATCH /users/current/tokens/{token_id}
Parameter	In	Type	Description
`token_id` required	path	`string`

Request body PatchToken required

Request body fields of PATCH /users/current/tokens/{token_id}
Field	Type	Description
`name`	`string \| null`
`ipAllowlist`	`string[] \| null`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X PATCH 'https://api.tickwire.io/users/current/tokens/TOKEN_ID' \
  -H 'auth-token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "PATCH",
        "/users/current/tokens/TOKEN_ID",
        json={},
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("PATCH", "/users/current/tokens/TOKEN_ID", {
  body: {},
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

DELETE `/users/current/tokens/{token_id}`

Revoke Token Auth: auth-token

Parameters of DELETE /users/current/tokens/{token_id}
Parameter	In	Type	Description
`token_id` required	path	`string`

Responses

204 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X DELETE 'https://api.tickwire.io/users/current/tokens/TOKEN_ID' \
  -H 'auth-token: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "DELETE",
        "/users/current/tokens/TOKEN_ID",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("DELETE", "/users/current/tokens/TOKEN_ID", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/access-rule-manifest`

Access Rule Manifest Auth: X-API-Key

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/access-rule-manifest' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/access-rule-manifest",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/access-rule-manifest");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/known-mt-servers/{version}/search`

Search Servers Auth: X-API-Key

Parameters of GET /v1/known-mt-servers/{version}/search
Parameter	In	Type	Description
`version` required	path	`integer`
`query`	query	`string`

Responses

200 Successful Response · object
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/known-mt-servers/5/search' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/known-mt-servers/5/search",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/known-mt-servers/5/search");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

Tokens and discovery

POST /users/current/narrow-down-auth-token

GET /users/current/regions

GET /users/current/servers/mt-client-api

GET /users/current/tokens

POST /users/current/tokens

GET /users/current/tokens/{token_id}

PATCH /users/current/tokens/{token_id}

DELETE /users/current/tokens/{token_id}

GET /v1/access-rule-manifest

GET /v1/known-mt-servers/{version}/search

POST `/users/current/narrow-down-auth-token`

GET `/users/current/regions`

GET `/users/current/servers/mt-client-api`

GET `/users/current/tokens`

POST `/users/current/tokens`

GET `/users/current/tokens/{token_id}`

PATCH `/users/current/tokens/{token_id}`

DELETE `/users/current/tokens/{token_id}`

GET `/v1/access-rule-manifest`

GET `/v1/known-mt-servers/{version}/search`