---
title: "returns detailed information about Service"
method: GET
path: "/api/v1/service/{namespace}/{service}"
---

# returns detailed information about Service

`GET /api/v1/service/{namespace}/{service}`

## Path parameters

- `namespace` string, required
- `service` string, required

## Query parameters

- `filterBy` string
- `sortBy` string
- `itemsPerPage` string
- `page` string
- `metricNames` string
- `aggregations` string

## Response `200`

OK

- ServiceServiceDetail
  - `clusterIP` string, required
  - `endpointList` EndpointEndpointList, required
    - `endpoints` EndpointEndpoint[], required
      - `host` string, required
      - `nodeName` string, required
      - `objectMeta` TypesObjectMeta, required
        - `annotations` object
        - `creationTimestamp` V1Time
          - `Time` string, date-time, required
        - `labels` object
        - `name` string
        - `namespace` string
        - `uid` string
      - `ports` V1EndpointPort[], required
        - `appProtocol` string — The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * Kubernetes-defined prefixed names: * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
        - `name` string — The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.
        - `port` integer, required — The port number of the endpoint.
        - `protocol` string — The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
      - `ready` boolean, required
      - `typeMeta` TypesTypeMeta, required
        - `kind` string
        - `restartable` boolean
        - `scalable` boolean
    - `listMeta` TypesListMeta, required
      - `totalItems` integer, required
  - `errors` Error[], required
    - unknown
  - `externalEndpoints` CommonEndpoint[], required
    - `host` string, required
    - `ports` CommonServicePort[], required
      - `nodePort` integer, required
      - `port` integer, required
      - `protocol` string, required
  - `internalEndpoint` CommonEndpoint, required
    - `host` string, required
    - `ports` CommonServicePort[], required
      - `nodePort` integer, required
      - `port` integer, required
      - `protocol` string, required
  - `objectMeta` TypesObjectMeta, required
    - `annotations` object
    - `creationTimestamp` V1Time
      - `Time` string, date-time, required
    - `labels` object
    - `name` string
    - `namespace` string
    - `uid` string
  - `selector` object, required
  - `sessionAffinity` string, required
  - `type` string, required
  - `typeMeta` TypesTypeMeta, required
    - `kind` string
    - `restartable` boolean
    - `scalable` boolean

---

[API](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api.md) · [All operations](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/karmada-io/kubernetes-dashboard-api/revisions/8521b53800a7/schema)
