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

# Get Service

> Reference for merged 0.6.0 source. The latest verified binary release is 0.5.5; use your Engine’s /api/openapi.json for its installed contract.



## OpenAPI

````yaml /engine/openapi.json get /api/services/{ident}
openapi: 3.1.0
info:
  title: nerditd
  version: 0.6.0
  description: >-
    Current source interface (0.6.0); verify your installed Engine version. This
    is not a claim that 0.6.0 is released.
servers:
  - url: http://127.0.0.1:9321
    description: Default local Engine; use your configured endpoint.
security: []
paths:
  /api/services/{ident}:
    get:
      tags:
        - Services
      summary: Get Service
      description: >-
        Reference for merged 0.6.0 source. The latest verified binary release is
        0.5.5; use your Engine’s /api/openapi.json for its installed contract.
      operationId: get_service
      parameters:
        - name: ident
          in: path
          required: true
          schema:
            type: string
            title: Ident
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
          description: HTTP 200 response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: HTTP 422 response
components:
  schemas:
    ServiceResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        status:
          $ref: '#/components/schemas/JobStatus'
        desired_state:
          anyOf:
            - type: string
            - type: 'null'
          title: Desired State
        kind:
          $ref: '#/components/schemas/JobKind'
          default: service
        image:
          anyOf:
            - type: string
            - type: 'null'
          title: Image
        gpu_count:
          type: integer
          title: Gpu Count
        gpu_ids:
          items:
            type: string
          type: array
          title: Gpu Ids
        restart_policy:
          anyOf:
            - type: string
            - type: 'null'
          title: Restart Policy
        restart_count:
          type: integer
          title: Restart Count
          default: 0
        health_check:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Health Check
        container_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Container Id
        created_at:
          type: string
          format: date-time
          title: Created At
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
        exit_code:
          anyOf:
            - type: integer
            - type: 'null'
          title: Exit Code
        error_class:
          anyOf:
            - $ref: '#/components/schemas/ErrorClass'
            - type: 'null'
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Message
        submitted_via:
          type: string
          title: Submitted Via
          default: cli
        manageable:
          type: boolean
          title: Manageable
        endpoint:
          anyOf:
            - $ref: '#/components/schemas/ServiceEndpointView'
            - type: 'null'
        rollback_available:
          type: boolean
          title: Rollback Available
          default: false
        build_version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Build Version
        last_deploy:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Last Deploy
        data_dir_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Data Dir Bytes
        source:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Source
      type: object
      required:
        - id
        - name
        - status
        - gpu_count
        - created_at
        - manageable
      title: ServiceResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    JobStatus:
      type: string
      enum:
        - pending
        - scheduled
        - running
        - paused
        - completed
        - failed
        - cancelled
        - retrying
        - building
        - degraded
        - restarting
        - stopped
      title: JobStatus
    JobKind:
      type: string
      enum:
        - batch
        - service
        - model
        - database
      title: JobKind
    ErrorClass:
      type: string
      enum:
        - OOM
        - GPU_FAIL
        - IMAGE_PULL_FAIL
        - USER_ERROR
        - TIMEOUT
        - CONTAINER_FAIL
        - MOUNT_MISSING
        - GPU_OOM
        - PLATFORM_ERROR
        - UNKNOWN
      title: ErrorClass
    ServiceEndpointView:
      properties:
        container_port:
          type: integer
          title: Container Port
        host_port:
          type: integer
          title: Host Port
        effective_host_port:
          type: integer
          title: Effective Host Port
        protocol:
          type: string
          title: Protocol
          default: tcp
        route:
          anyOf:
            - type: string
            - type: 'null'
          title: Route
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        public_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Public Url
        public_urls:
          items:
            $ref: '#/components/schemas/PublicUrlEntry'
          type: array
          title: Public Urls
      type: object
      required:
        - container_port
        - host_port
        - effective_host_port
      title: ServiceEndpointView
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PublicUrlEntry:
      properties:
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        kind:
          type: string
          enum:
            - default
            - hosted
            - domain
          title: Kind
        state:
          type: string
          enum:
            - ready
            - link_down
            - not_entitled
            - withheld
          title: State
        access:
          anyOf:
            - type: string
              enum:
                - private
                - public
            - type: 'null'
          title: Access
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        cert_state:
          anyOf:
            - type: string
              enum:
                - internal
                - disabled
                - pending
                - issued
                - expired
            - type: 'null'
          title: Cert State
      type: object
      required:
        - url
        - kind
        - state
      title: PublicUrlEntry

````