> ## Documentation Index > Fetch the complete documentation index at: https://docs.restate.dev/llms.txt > Use this file to discover all available pages before exploring further. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback: POST https://docs.restate.dev/feedback ```json { "path": "/admin-api/service_handler/get-service-handler", "feedback": "Description of the issue" } ``` Only submit feedback when you have something specific and actionable to report. # Get service handler > Returns detailed metadata about a specific handler within a service, including its input/output types and handler type. ## OpenAPI ````yaml /schemas/openapi-admin.json get /services/{service}/handlers/{handler} openapi: 3.1.0 info: title: Admin API description: >- This API exposes the admin operations of a Restate cluster, such as registering new service deployments, interacting with running invocations, register Kafka subscriptions, retrieve service metadata. For an overview, check out the [Operate documentation](https://docs.restate.dev/operate/). If you're looking for how to call your services, check out the [Ingress HTTP API](https://docs.restate.dev/invoke/http) instead. contact: name: restate.dev license: name: MIT url: https://opensource.org/license/mit version: 1.6.2 servers: [] security: [] tags: - name: deployment description: Service Deployment management - name: invocation description: Invocation management externalDocs: url: https://docs.restate.dev/operate/invocation description: Invocations documentation - name: subscription description: Subscription management externalDocs: url: https://docs.restate.dev/operate/invocation#managing-kafka-subscriptions description: Kafka subscriptions documentation - name: service description: Service management - name: service_handler description: Service handlers metadata - name: cluster_health description: Cluster health - name: health description: Admin API health - name: version description: API Version - name: introspection description: System introspection externalDocs: url: https://docs.restate.dev/operate/ description: Restate operations documentation paths: /services/{service}/handlers/{handler}: get: tags: - service_handler summary: Get service handler description: >- Returns detailed metadata about a specific handler within a service, including its input/output types and handler type. operationId: get_service_handler parameters: - name: service in: path description: Fully qualified service name. required: true schema: type: string - name: handler in: path description: Handler name. required: true schema: type: string responses: '200': description: Handler metadata including input/output types and configuration content: application/json: schema: $ref: '#/components/schemas/HandlerMetadata' '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/MethodNotAllowed' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' components: schemas: HandlerMetadata: type: object description: Handler metadata required: - name - input_description - output_description properties: abort_timeout: type: - string - 'null' description: >- # Abort timeout This timer guards against stalled service/handler invocations that are supposed to terminate. The abort timeout is started after the 'inactivity timeout' has expired and the service/handler invocation has been asked to gracefully terminate. Once the timer expires, it will abort the service/handler invocation. This timer potentially **interrupts** user code. If the user code needs longer to gracefully terminate, then this value needs to be set accordingly. Can be configured using the [`jiff::fmt::friendly`](https://docs.rs/jiff/latest/jiff/fmt/friendly/index.html) format or ISO8601, for example `5 hours`. If set, it overrides the value set in the service. documentation: type: - string - 'null' description: |- # Documentation Documentation of the handler, as propagated by the SDKs. enable_lazy_state: type: - boolean - 'null' description: >- # Enable lazy state If true, lazy state will be enabled for all invocations to this service. This is relevant only for Workflows and Virtual Objects. If set, it overrides the value set in the service. idempotency_retention: type: - string - 'null' description: >- # Idempotency retention The retention duration of idempotent requests for this handler. If set, it overrides the value set in the service. Can be configured using the [`jiff::fmt::friendly`](https://docs.rs/jiff/latest/jiff/fmt/friendly/index.html) format or ISO8601, for example `5 hours`. inactivity_timeout: type: - string - 'null' description: >- # Inactivity timeout This timer guards against stalled service/handler invocations. Once it expires, Restate triggers a graceful termination by asking the service invocation to suspend (which preserves intermediate progress). The 'abort timeout' is used to abort the invocation, in case it doesn't react to the request to suspend. Can be configured using the [`jiff::fmt::friendly`](https://docs.rs/jiff/latest/jiff/fmt/friendly/index.html) format or ISO8601, for example `5 hours`. If set, it overrides the value set in the service. info: type: array items: $ref: '#/components/schemas/Info' description: >- # Info List of configuration/deprecation information related to this handler. input_description: type: string description: |- # Human readable input description If empty, no schema was provided by the user at discovery time. input_json_schema: description: |- # Input JSON Schema JSON Schema of the handler input journal_retention: type: - string - 'null' description: >- # Journal retention The journal retention. When set, this applies to all requests to this handler. In case the invocation has an idempotency key, the `idempotency_retention` caps the maximum `journal_retention` time. In case this handler is a workflow handler, the `workflow_completion_retention` caps the maximum `journal_retention` time. Can be configured using the [`jiff::fmt::friendly`](https://docs.rs/jiff/latest/jiff/fmt/friendly/index.html) format or ISO8601, for example `5 hours`. If set, it overrides the value set in the service. metadata: type: object description: |- # Metadata Additional handler metadata, as propagated by the SDKs. additionalProperties: type: string propertyNames: type: string name: type: string description: |- # Name The handler name. output_description: type: string description: |- # Human readable output description If empty, no schema was provided by the user at discovery time. output_json_schema: description: |- # Output JSON Schema JSON Schema of the handler output public: type: boolean description: >- # Public If true, this handler can be invoked through the ingress. If false, this handler can be invoked only from another Restate service. retry_policy: $ref: '#/components/schemas/HandlerRetryPolicyMetadata' description: |- # Retry policy Retry policy overrides applied for this handler. ty: oneOf: - type: 'null' - $ref: '#/components/schemas/HandlerMetadataType' description: |- # Type The handler type. Info: type: object required: - message properties: code: type: - string - 'null' message: type: string HandlerRetryPolicyMetadata: type: object description: '# Handler retry policy overrides' properties: exponentiation_factor: type: - number - 'null' format: float description: |- # Factor The factor to use to compute the next retry attempt. initial_interval: type: - string - 'null' description: >- # Initial Interval Initial interval for the first retry attempt. Can be configured using the [`jiff::fmt::friendly`](https://docs.rs/jiff/latest/jiff/fmt/friendly/index.html) format or ISO8601, for example `5 hours`. max_attempts: type: - integer - 'null' description: >- # Max attempts Number of maximum attempts (including the initial) before giving up. Infinite retries if unset. No retries if set to 1. minimum: 1 max_interval: type: - string - 'null' description: >- # Max interval Maximum interval between retries. Can be configured using the [`jiff::fmt::friendly`](https://docs.rs/jiff/latest/jiff/fmt/friendly/index.html) format or ISO8601, for example `5 hours`. on_max_attempts: oneOf: - type: 'null' - $ref: '#/components/schemas/OnMaxAttempts' description: |- # On max attempts Behavior when max attempts are reached. HandlerMetadataType: type: string enum: - Exclusive - Shared - Workflow ErrorDescriptionResponse: type: object description: |- # Error description response Error details of the response required: - message properties: message: type: string restate_code: type: - string - 'null' description: |- # Restate code Restate error code describing this error OnMaxAttempts: type: string enum: - Pause - Kill responses: BadRequest: description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorDescriptionResponse' NotFound: description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorDescriptionResponse' MethodNotAllowed: description: Method not allowed content: application/json: schema: $ref: '#/components/schemas/ErrorDescriptionResponse' Conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/ErrorDescriptionResponse' InternalServerError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorDescriptionResponse' ````