A ticket for this import’s live socket

POST

/orgs/{org}/imports/{id}/socket

curl --request POST \
  --url https://api.sloose.com/orgs/org_9f3c/imports/imp_4d1a/socket \
  --header 'Authorization: Bearer <token>'

• Production
• Staging

A one-use ticket, good for a minute, for a WebSocket to this import’s room — which tells everybody with the import open who else has it open, when somebody else changes it, and the run holding it as it goes (GET …/live has the frames). A browser cannot put a header on a WebSocket upgrade and a session token in an address lands in every log on the way, so the socket is opened with this ticket instead: url is the address to open, ticket included. The ticket is bound to this session and this import, and the room admits the socket only while the session is still in the import’s org. A signed-in session only: an API token has no socket.

Authorizations

• sessionAuth

Parameters

Path Parameters

org

required

The org id the session was issued for. A token for one org can never read another.

string

Example

org_9f3c

The org id the session was issued for. A token for one org can never read another.

id

required

The import id.

string

Example

imp_4d1a

The import id.

Responses

200

A ticket, and the address to open with it.

Media typeapplication/json

object

ticket

required

string

url

required

The socket’s address, wss://…/live?ticket=….

string

expiresAt

required

When the ticket stops being accepted.

string

Example^generated

{
  "ticket": "example",
  "url": "example",
  "expiresAt": "example"
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

An API token (code: SESSION_REQUIRED), a staff member’s read-only view, or a session in another org.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

404

No such import, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}