GET /systems/info
Basic auth

Returns information about the authenticated system, including suspension and organization status.

Responses

  • 200 application/json

    System info retrieved successfully

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object
      Hide data attributes Show data attributes object
      • system_id string
      • system_key string
      • name string
      • type string | null
      • fqdn string | null
      • status string
      • suspended boolean
      • suspended_at string(date-time) | null
      • deleted boolean
      • deleted_at string(date-time) | null
      • registered boolean
      • registered_at string(date-time) | null
      • created_at string(date-time)
      • rebranding_enabled boolean

        Whether rebranding is enabled for this system (directly or inherited through hierarchy)

      • organization object
        Hide organization attributes Show organization attributes object
        • id string

          Database UUID of the organization

        • logto_id string

          Logto organization ID

        • name string

          Organization name

        • type string

          Organization type in the hierarchy

          Values are owner, distributor, reseller, or customer.

        • suspended boolean
        • suspended_at string(date-time) | null
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 404 application/json

    System not found or deleted

    Hide response attributes Show response attributes object
    • code integer

      HTTP error code

    • message string

      Error message

    • data object
      Hide data attributes Show data attributes object
      • type string

        Type of error

        Values are validation_error or external_api_error.

      • errors array[object]
        Hide errors attributes Show errors attributes object
        • key string

          Field name that failed validation

        • message string

          Error code or message

        • value string

          Value that failed validation

      • details

        Additional error details
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
GET /systems/info 
curl \
 --request GET 'https://collect.your-domain.com/api/systems/info' \
 --user "username:password"
Response examples (200) 
{
  "code": 200,
  "message": "system info retrieved successfully",
  "data": {
    "system_id": "abc-123",
    "system_key": "my-system-key",
    "name": "Milan Office Server",
    "type": "ns8",
    "fqdn": "server.example.com",
    "status": "online",
    "suspended": false,
    "suspended_at": "2026-05-04T09:42:00Z",
    "deleted": false,
    "deleted_at": "2026-05-04T09:42:00Z",
    "registered": true,
    "registered_at": "2025-01-15T10:00:00Z",
    "created_at": "2025-01-10T08:00:00Z",
    "rebranding_enabled": false,
    "organization": {
      "id": "4405ffd0-0aca-44ef-bae2-c8545bce94f4",
      "logto_id": "akkbs6x2wo82",
      "name": "Owner",
      "type": "owner",
      "suspended": false,
      "suspended_at": "2026-05-04T09:42:00Z"
    }
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (404) 
{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}
Response examples (500) 
{
  "code": 500,
  "message": "internal server error",
  "data": {}
}