---
title: "Get service by filters"
method: GET
path: "/service"
tags: ["services"]
---

# Get service by filters

`GET /service`

Get service by filters

## Query parameters

- `environmentId` string, id
- `namespaceId` string, id
- `name` string, k8s-name

## Response `200`

Get service by filters

- Service
  - `aliases` ServerAlias[]
    - `kind` string
    - `name` string, required
  - `awsResource` AWSResource
    - `info` object, required
    - `type` 'GENERAL' | 'S3', required
  - `awsVisibility` AWSVisibility
    - `arn` string, required
    - `domain` string
    - `eksIngressName` string
    - `ips` string[], required
    - `lbArn` string
    - `name` string, required
    - `region` string, required
    - `resourceType` 'EKS', required
  - `azureResource` AzureResource
    - `resource` string, required
  - `certificateInformation` CertificateInformation
    - `commonName` string, required
    - `dnsNames` string[]
    - `ttl` integer
  - `cloudIam` CloudIam
    - `awsRoles` string[]
  - `databaseIntegration` object
    - `id` string, required
  - `detectedCloudServer` DetectedCloudServer
    - `cloudProvider` string, required
    - `cloudService` string, required
    - `region` string, required
  - `discoveredByIntegration` object
    - `id` string, required
  - `environment` object, required
    - `id` string, required
  - `gcpResource` GCPResource
    - `resource` string, required
  - `id` string, required
  - `kafkaServerConfig` KafkaServerConfig
    - `address` string
    - `topics` KafkaTopic[], required
      - `clientIdentityRequired` boolean, required
      - `intentsRequired` boolean, required
      - `pattern` 'LITERAL' | 'PREFIX', required
      - `topic` string, required
  - `name` string, required
  - `namespace` Namespace
    - `cluster` Cluster, required
      - `components` IntegrationComponents, required
        - `credentialsOperator` CredentialsOperatorComponent, required
          - `status` ComponentStatus, required
            - `lastSeen` string, date-time
            - `type` 'NOT_INTEGRATED' | 'CONNECTED' | 'DISCONNECTED', required
          - `type` 'INTENTS_OPERATOR' | 'CREDENTIALS_OPERATOR' | 'NETWORK_MAPPER', required
        - `intentsOperator` IntentsOperatorComponent, required
          - `configuration` IntentsOperatorConfiguration
            - `awsIAMPolicyEnforcementEnabled` boolean, required
            - `azureIAMPolicyEnforcementEnabled` boolean, required
            - `databaseEnforcementEnabled` boolean, required
            - `egressNetworkPolicyEnforcementEnabled` boolean, required
            - `enforcedNamespaces` string[]
            - `gcpIAMPolicyEnforcementEnabled` boolean, required
            - `globalEnforcementEnabled` boolean, required
            - `istioPolicyEnforcementEnabled` boolean, required
            - `kafkaACLEnforcementEnabled` boolean, required
            - `linkerdPolicyEnforcementEnabled` boolean, required
            - `networkPolicyEnforcementEnabled` boolean, required
            - `protectedServices` object[], required
              - …
            - `protectedServicesEnabled` boolean, required
          - `status` ComponentStatus, required
            - `lastSeen` string, date-time
            - `type` 'NOT_INTEGRATED' | 'CONNECTED' | 'DISCONNECTED', required
          - `type` 'INTENTS_OPERATOR' | 'CREDENTIALS_OPERATOR' | 'NETWORK_MAPPER', required
        - `networkMapper` NetworkMapperComponent, required
          - `status` ComponentStatus, required
            - `lastSeen` string, date-time
            - `type` 'NOT_INTEGRATED' | 'CONNECTED' | 'DISCONNECTED', required
          - `type` 'INTENTS_OPERATOR' | 'CREDENTIALS_OPERATOR' | 'NETWORK_MAPPER', required
      - `configuration` ClusterConfiguration
        - `clusterFormSettings` ClusterFormSettings, required
          - `certificateProvider` 'SPIRE' | 'CERT_MANAGER' | 'CLOUD' | 'NONE', required
          - `enforcement` boolean, required
        - `globalDefaultDeny` boolean, required
        - `istioGlobalDefaultDeny` boolean, required
        - `linkerdGlobalDefaultDeny` boolean, required
        - `useAWSIAMInAccessGraphStates` boolean, required
        - `useAzureIAMInAccessGraphStates` boolean, required
        - `useDatabaseInAccessGraphStates` boolean, required
        - `useGCPIAMInAccessGraphStates` boolean, required
        - `useIstioPoliciesInAccessGraphStates` boolean, required
        - `useKafkaACLsInAccessGraphStates` boolean, required
        - `useLinkerdPoliciesInAccessGraphStates` boolean, required
        - `useNetworkPoliciesInAccessGraphStates` boolean, required
      - `createdAt` string, date-time, required
      - `defaultEnvironment` object
        - `id` string, required
      - `id` string, required
      - `integration` object
        - `id` string, required
      - `integrations` object[], required
        - `id` string, required
      - `name` string, required
      - `namespaces` object[], required
        - `id` string, required
      - `serviceCount` integer, required
    - `environment` object, required
      - `id` string, required
    - `id` string, required
    - `name` string, required
    - `serviceCount` integer, required
    - `services` object[], required
      - `id` string, required
  - `networkPolicies` object[]
    - `id` string, required
  - `serviceAccount` string
  - `tags` string[]
  - `workloadKind` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `408` — Request Timeout
- `409` — Conflict
- `422` — Unprocessable Entity
- `500` — Internal Server Error
- `default`

## Changes

> 33 revisions in range; 1 could not be searched.

- **2025-04-16** `6b4369907cb8` — 6 info
  - added the non-success response with the status `408`
  - added the optional property `cloudIam` to the response with the `200` status
  - added the optional property `networkPolicies` to the response with the `200` status
  - added the required property `namespace/cluster/components/intentsOperator/configuration/linkerdPolicyEnforcementEnabled` to the response with the `200` status
  - …2 more
- **2024-12-02** `aabf75d38bc6` — 1 info
  - added the optional property `detectedCloudServer` to the response with the `200` status
- **2024-10-21** `7aec65a7fcfd` — 12 info
  - added the optional property `aliases` to the response with the `200` status
  - added the optional property `awsVisibility` to the response with the `200` status
  - added the optional property `azureResource` to the response with the `200` status
  - added the optional property `databaseIntegration` to the response with the `200` status
  - …8 more
- …earlier changes not shown

[Full history](https://skmtc.dev/otterize/apis/otterize-api-server/changes/service/get.md)

---

[API](https://skmtc.dev/otterize/apis/otterize-api-server.md) · [All operations](https://skmtc.dev/otterize/apis/otterize-api-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/otterize/otterize-api-server/revisions/ec9167824493/schema)