--- title: "Get a Service" url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/operations/fetch-catalog-service" --- > Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md # Get a Service `GET` `/catalog-services/{id}` Operation ID: `fetch-catalog-service` Fetches a service. ## Path parameters - `id` (string, required) - The `id` of the service. ## Responses - `200` - A response containing a single service object. - `401` - Unauthorized - `403` - Forbidden - `404` - Not Found ## OpenAPI definition ```yaml openapi: 3.0.3 info: title: Konnect Service Catalog version: 1.3.0 servers: - url: https://us.api.konghq.com/v1 description: United-States Production region - url: https://eu.api.konghq.com/v1 description: Europe Production region - url: https://au.api.konghq.com/v1 description: Australia Production region - url: https://me.api.konghq.com/v1 description: Middle-East Production region - url: https://in.api.konghq.com/v1 description: India Production region - url: https://sg.api.konghq.com/v1 description: Singapore Production region paths: /catalog-services/{id}: parameters: - schema: type: string example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 name: id in: path required: true description: The `id` of the service. get: x-speakeasy-entity-operation: terraform-resource: CatalogService#read terraform-datasource: null summary: Get a Service description: Fetches a service. operationId: fetch-catalog-service responses: "200": $ref: "#/components/responses/CatalogServiceResponse" "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" "404": $ref: "#/components/responses/NotFound" tags: - Catalog Services security: - konnectAccessToken: [] - personalAccessToken: [] - systemAccountAccessToken: [] components: responses: CatalogServiceResponse: description: A response containing a single service object. content: application/json: schema: $ref: "#/components/schemas/CatalogService" examples: Service: $ref: "#/components/examples/SampleServiceResponse" Unauthorized: description: Unauthorized content: application/problem+json: schema: $ref: "#/components/schemas/UnauthorizedError" examples: UnauthorizedExample: $ref: "#/components/examples/UnauthorizedExample" Forbidden: description: Forbidden content: application/problem+json: schema: $ref: "#/components/schemas/ForbiddenError" examples: UnauthorizedExample: $ref: "#/components/examples/ForbiddenExample" NotFound: description: Not Found content: application/problem+json: schema: $ref: "#/components/schemas/NotFoundError" examples: NotFoundExample: $ref: "#/components/examples/NotFoundExample" schemas: CatalogService: title: CatalogService description: The service object contains information about a Service Catalog service. type: object required: - id - name - display_name - description - custom_fields - labels - created_at - updated_at properties: id: type: string format: uuid example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 description: The service ID. readOnly: true name: type: string description: > The machine name of the Service that uniquely identifies it within the catalog. minLength: 1 maxLength: 120 pattern: ^[0-9a-z.-]+$ example: user-svc display_name: type: string description: The display name of the Service. minLength: 1 maxLength: 120 example: User Service description: type: string description: Optionally provide a description of the Service. nullable: true maxLength: 2048 custom_fields: $ref: "#/components/schemas/CustomFields" labels: $ref: "#/components/schemas/Labels" created_at: $ref: "#/components/schemas/CreatedAt" updated_at: $ref: "#/components/schemas/UpdatedAt" UnauthorizedError: allOf: - $ref: "#/components/schemas/BaseError" - type: object properties: status: example: 401 title: example: Unauthorized type: example: https://httpstatuses.com/401 instance: example: kong:trace:1234567890 detail: example: Invalid credentials ForbiddenError: allOf: - $ref: "#/components/schemas/BaseError" - type: object properties: status: example: 403 title: example: Forbidden type: example: https://httpstatuses.com/403 instance: example: kong:trace:1234567890 detail: example: Forbidden NotFoundError: allOf: - $ref: "#/components/schemas/BaseError" - type: object properties: status: example: 404 title: example: Not Found type: example: https://httpstatuses.com/404 instance: example: kong:trace:1234567890 detail: example: Not found CustomFields: type: object x-speakeasy-type-override: any description: > Map of customizable, catalog-defined fields providing information about a service. additionalProperties: x-convert-oneOf: true anyOf: - $ref: "#/components/schemas/TextCustomField" - $ref: "#/components/schemas/NumericCustomField" - $ref: "#/components/schemas/BooleanCustomField" - $ref: "#/components/schemas/UrlCustomField" example: owner: John Appleseed dashboard: name: On-Call Dashboard link: https://my-dashboard-svc.io/dashboards/1 Labels: title: Labels type: object example: env: test maxProperties: 50 description: > Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". additionalProperties: type: string pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ minLength: 1 maxLength: 63 CreatedAt: type: string format: date-time example: 2022-11-04T20:10:06.927Z description: An ISO-8601 timestamp representation of entity creation date. readOnly: true x-speakeasy-param-suppress-computed-diff: true UpdatedAt: type: string format: date-time example: 2022-11-04T20:10:06.927Z description: An ISO-8601 timestamp representation of entity update date. readOnly: true x-speakeasy-param-suppress-computed-diff: true BaseError: type: object title: Error description: standard error required: - status - title - instance - detail properties: status: type: integer description: > The HTTP status code of the error. Useful when passing the response body to child properties in a frontend UI. Must be returned as an integer. readOnly: true title: type: string description: | A short, human-readable summary of the problem. It should not change between occurences of a problem, except for localization. Should be provided as "Sentence case" for direct use in the UI. readOnly: true type: type: string description: The error type. readOnly: true instance: type: string description: | Used to return the correlation ID back to the user, in the format kong:trace:. This helps us find the relevant logs when a customer reports an issue. readOnly: true detail: type: string description: > A human readable explanation specific to this occurence of the problem. This field may contain request/entity data to help the user understand what went wrong. Enclose variable values in square brackets. Should be provided as "Sentence case" for direct use in the UI. readOnly: true TextCustomField: type: string nullable: true NumericCustomField: type: number nullable: true BooleanCustomField: type: boolean nullable: true UrlCustomField: type: object nullable: true required: - name - link properties: name: description: The human-readable name of the URL link. type: string example: On-Call Dashboard link: description: The href value of the URL link. type: string format: uri-reference example: https://my-dashboard-svc.io/dashboards/1 examples: SampleServiceResponse: value: id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 name: sample-service display_name: Sample Service description: This is a sample service custom_fields: owner: John Appleseed cost_center: Research and Development product_manager: Jane jira_project: name: Sample Jira Project link: https://my-company.atlassian.net/jira/software/c/projects/SAMPLE dashboard: name: Sample Dashboard link: https://my-company.dashboards.com/sample-dashboard git_repo: name: Sample Project link: https://github.com/MyCompany/SampleProject slack_channel: name: My Company Channel link: https://my-company.slack.com/archives/C000AAAAAAA labels: env: test created_at: 2022-11-04T20:10:06.927Z updated_at: 2022-11-04T20:10:06.927Z UnauthorizedExample: value: status: 401 title: Unauthorized instance: kong:trace:8347343766220159418 detail: Unauthorized ForbiddenExample: value: status: 403 title: Forbidden instance: kong:trace:2723154947768991354 detail: You do not have permission to perform this action NotFoundExample: value: status: 404 title: Not Found instance: kong:trace:6816496025408232265 detail: Not Found securitySchemes: konnectAccessToken: type: http scheme: bearer bearerFormat: JWT description: > The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with. personalAccessToken: type: http scheme: bearer bearerFormat: Token description: > The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard. The PAT token must be passed in the header of a request, for example: `curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'` systemAccountAccessToken: type: http scheme: bearer bearerFormat: Token description: > The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account. The access token must be passed in the header of a request, for example: `curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'` ```