> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dezerx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get provider details

> Provider side data of the service, grouped in sections (server, user, account, license, per-hour), with field definitions. Secrets are never returned. Rate limited to 30 requests per minute per IP.

**Permission:** `services.details.read`

**Rate limit:** 30 requests per minute per IP.



## OpenAPI

````yaml /docs/service-api.yaml get /services/{service}/details
openapi: 3.1.0
info:
  title: Spartan Service API
  version: '2026.11'
  description: >-
    Services: create, read and update, lifecycle actions, billing and pricing,
    plan changes, notes, members, addons, provider details and dispute evidence.


    All requests need an API key from **Admin, API** in the `Authorization:
    Bearer <key>` header. Replace `{domain}` with the domain of your Spartan
    installation. Successful responses use the envelope `{"data": ..., "meta":
    {"request_id": ...}}`; errors use `{"error": {"code", "message", "details"},
    "request_id"}`.
servers:
  - url: https://{domain}/api/application
    description: Your Spartan installation
    variables:
      domain:
        default: billing.example.com
        description: Domain of your Spartan installation, without https://
security:
  - bearerAuth: []
tags:
  - name: Services
  - name: Lifecycle
  - name: Billing
  - name: Upgrades
  - name: Notes
  - name: Members
  - name: Addons
  - name: Service details
  - name: Evidence
paths:
  /services/{service}/details:
    get:
      tags:
        - Service details
      summary: Get provider details
      description: >-
        Provider side data of the service, grouped in sections (server, user,
        account, license, per-hour), with field definitions. Secrets are never
        returned. Rate limited to 30 requests per minute per IP.


        **Permission:** `services.details.read`


        **Rate limit:** 30 requests per minute per IP.
      operationId: getServiceDetails
      parameters:
        - name: service
          in: path
          required: true
          description: Service id.
          schema:
            type: integer
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ServiceDetails'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
              example:
                data:
                  provider:
                    key: LicenseService
                    name: License
                    description: Manage license key, domain, and IP address settings
                  service:
                    id: 880
                    name: Spartan Ultimate
                    status: active
                    created_at: '2026-11-14T16:08:41.000000Z'
                    updated_at: '2026-11-14T16:08:44.000000Z'
                  editable_sections:
                    - license
                  sections:
                    - key: license
                      label: License Details
                      data:
                        id: 87
                        license_key: SPARTAN-7F3K-29QD-M4XW-81PL
                        domain: billing.example.com
                        ip_address: null
                        is_active: true
                        extra_licenses: []
                        last_rotated: null
                        last_seen_at: null
                        last_seen_ip: null
                        hwid_devices: 0
                        user_id: 2
                        product_id: 64
                        service_id: 880
                        created_at: '2026-11-14T16:08:43Z'
                        updated_at: '2026-11-14T16:08:43Z'
                      fields:
                        - key: license_key
                          label: License Key
                          type: monospace
                        - key: domain
                          label: Domain
                          type: text
                      editFields:
                        - key: license_key
                          label: License Key
                          type: monospace
                          readOnly: false
                          required: true
                        - key: domain
                          label: Domain
                          type: text
                          readOnly: false
                          placeholder: example.com
                      arrayFields:
                        - key: extra_licenses
                          label: Extra Licenses
                          nameField: name
                          valueField: key
                          fallbackLabel: License
                          valueType: monospace
                      emptyState:
                        icon: 🔑
                        title: No License Data
                        description: No license information available for this service.
                      editConfigFields: []
                      editable: true
                      update_endpoint: /services/880/details/license
                meta:
                  request_id: 52892f82-4be5-4e94-9878-f2e2c8ebdf2d
          headers:
            X-RateLimit-Limit:
              description: Requests allowed per minute.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current minute.
              schema:
                type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Conflict with the current state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                service_details_unavailable:
                  summary: No provider details
                  value:
                    error:
                      code: service_details_unavailable
                      message: This service has no provider details.
                      details: {}
                    request_id: b9e810ca-3047-414d-b932-23624c1643fb
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    ServiceDetails:
      type: object
      properties:
        provider:
          type: object
          properties:
            key:
              type: string
              description: Provider key, for example `license`, `pterodactyl`, `cpanel`.
            name:
              type: string
            description:
              type:
                - string
                - 'null'
        service:
          type: object
          properties:
            id:
              type: integer
            name:
              type:
                - string
                - 'null'
            status:
              type: string
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
        editable_sections:
          type: array
          items:
            type: string
            enum:
              - server
              - user
              - account
              - license
              - per-hour
          description: Sections that accept `PUT /services/{service}/details/{section}`.
        sections:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                description: Section key.
              label:
                type: string
              data:
                type: object
                properties: {}
                description: >-
                  Provider data for the section. Secrets (passwords, API keys,
                  tokens) are never returned.
                additionalProperties: true
              fields:
                type: array
                items:
                  type: object
                  properties: {}
                  additionalProperties: true
                description: Read only field definitions.
              editFields:
                type: array
                items:
                  type: object
                  properties: {}
                  additionalProperties: true
                description: >-
                  Editable field definitions (key, label, type, readOnly,
                  required).
              arrayFields:
                type: array
                items:
                  type: object
                  properties: {}
                  additionalProperties: true
              emptyState:
                type:
                  - object
                  - 'null'
                properties: {}
                additionalProperties: true
              editConfigFields:
                type: array
                items:
                  type: object
                  properties: {}
                  additionalProperties: true
                description: Editable keys inside `config`.
              editable:
                type: boolean
              update_endpoint:
                type:
                  - string
                  - 'null'
                description: Path to update this section.
    Meta:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: Request id, also sent in the `X-Request-ID` response header.
      required:
        - request_id
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine readable error code, for example `unauthorized`,
                `forbidden`, `not_found`, `invalid_service_state`.
            message:
              type: string
              description: Human readable explanation.
            details:
              type: object
              properties: {}
              description: Extra context. An empty object for most errors.
              additionalProperties: true
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: >-
            Request id. Also returned in the `X-Request-ID` header. Send your
            own with `X-Request-ID` to correlate logs.
      description: Error envelope returned by every failed request.
      required:
        - error
        - request_id
  responses:
    Unauthorized:
      description: Missing, invalid or inactive API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: No Authorization header
              value:
                error:
                  code: unauthorized
                  message: Bearer token required.
                  details: {}
                request_id: 9aca26ca-e06f-4725-8e4b-4385d6c03422
            invalid:
              summary: Unknown or inactive key
              value:
                error:
                  code: unauthorized
                  message: Invalid or inactive token.
                  details: {}
                request_id: 8802a669-6f06-453e-a1d8-0b81621167c3
    Forbidden:
      description: >-
        The key lacks the permission for this endpoint, or the request IP is not
        in the key allow list.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            forbidden:
              summary: Missing permission
              value:
                error:
                  code: forbidden
                  message: Insufficient permissions for this action.
                  details: {}
                request_id: 191c51e1-03a3-448e-8df7-3c584be888b0
            ip_not_allowed:
              summary: IP not allowed
              value:
                error:
                  code: ip_not_allowed
                  message: Access denied from this IP address.
                  details: {}
                request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
    NotFound:
      description: The resource in the path does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: The requested resource was not found.
              details: {}
            request_id: cccbc627-4fd4-4727-889e-fa727c48792c
    TooManyRequests:
      description: Rate limit reached. Wait `Retry-After` seconds.
      headers:
        Retry-After:
          description: Seconds until the limit resets.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests allowed per minute.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current minute.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: too_many_requests
              message: >-
                Too many requests. Retry after the number of seconds in the
                Retry-After header.
              details: {}
            request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in Admin, API. Send it as `Authorization: Bearer <key>`.
        Each key has its own permissions and optional IP allow list.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.