Sessions

Create session

post

Requires WRITE or READ_WRITE api key access type.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Body

application/json

deviceidstringRequired

aliasstringOptional

Responses

201

Session inserted succesfully

application/json

400

Bad request

application/json

403

Forbidden

application/json

404

Not found

application/json

409

Conflict

application/json

500

Internal server error

application/json

post

/sessions

HTTPcURLJavaScriptPython

POST /v0/sessions HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "deviceid": "59B35FB49E14C498EE9472B73F7DB2EFC6677AFF0F3CEE0B73FCE110F6370EA4",
  "alias": "My session"
}

{
  "body": {
    "description": "text",
    "token_session": "text"
  }
}

Get session by token

get

Requires READ or READ_WRITE api key access type.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Path parameters

token_sessionstring · min: 8Required

Session token.

Responses

200

Success

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/sessions/{token_session}

HTTPcURLJavaScriptPython

GET /v0/sessions/{token_session} HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Accept: */*

{
  "body": {
    "description": "text",
    "result": [
      {
        "token_session": "text",
        "alias": "text",
        "creation_date": "2026-05-17T00:56:21.899Z",
        "duration": 1,
        "active": true,
        "passings": 1,
        "first": "2026-05-17T00:56:21.899Z",
        "last": "2026-05-17T00:56:21.899Z"
      }
    ]
  }
}

List sessions by device

get

Requires READ or READ_WRITE api key access type.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Path parameters

deviceidstring · min: 8Required

Device identifier.

Responses

200

Success

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/sessions/device/{deviceid}

HTTPcURLJavaScriptPython

GET /v0/sessions/device/{deviceid} HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Accept: */*

{
  "body": {
    "description": "text",
    "result": [
      {
        "token_session": "text",
        "alias": "text",
        "creation_date": "2026-05-17T00:56:21.899Z",
        "duration": 1,
        "active": true,
        "passings": 1
      }
    ]
  }
}

Get active session for device

get

Requires READ or READ_WRITE api key access type.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Path parameters

deviceidstring · min: 8Required

Device identifier.

Responses

200

Success

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/sessions/device/{deviceid}/active

HTTPcURLJavaScriptPython

GET /v0/sessions/device/{deviceid}/active HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Accept: */*

{
  "body": {
    "description": "text",
    "result": [
      {
        "token_session": "text",
        "alias": "text",
        "creation_date": "2026-05-17T00:56:21.899Z",
        "duration": 1,
        "active": true,
        "passings": 1
      }
    ]
  }
}

Close session

patch

Requires WRITE or READ_WRITE api key access type.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Path parameters

token_sessionstring · min: 8Required

Session token.

Responses

200

Session closed succesfully

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal server error

application/json

patch

/sessions/close/{token_session}

HTTPcURLJavaScriptPython

PATCH /v0/sessions/close/{token_session} HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Accept: */*

{
  "body": {
    "description": "text",
    "token_session": "text"
  }
}