---
title: "List pod scheduling policies"
method: GET
path: "/pod-scheduling-policies"
tags: ["Pod Scheduling Policy"]
---

# List pod scheduling policies

`GET /pod-scheduling-policies`

## Request

- Base URL: `/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/pod-scheduling-policies`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/openeverest/apis/openeverest-schema/docs/pod-scheduling-policies/get.ts> (a function with typed inputs; its response is checked against the schema)

This API lists all pod scheduling policies in the kubernetes cluster.

## Query parameters

- `engineType` 'pxc' | 'psmdb' | 'postgresql'
- `hasRules` boolean

## Response `200`

Successful operation

- PodSchedulingPolicyList: PodSchedulingPolicyList is an object that contains the list of the existing pod scheduling policies.
  - `apiVersion` string: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  - `kind` string: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  - `items` PodSchedulingPolicy[]
    - `apiVersion` string: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    - `kind` string: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    - `metadata` object
    - `spec` object: PodSchedulingPolicySpec defines the desired state of PodSchedulingPolicy.
      - `affinityConfig` object: AffinityConfig is a configuration for the affinity settings depending on the engine type.
        - `postgresql` object: PostgreSQL is the affinity configuration for the PostgreSQL DB clusters.
          - `engine` object: Engine is the affinity configuration for the DB Engine pods.
            - `nodeAffinity` object: Describes node affinity scheduling rules for the pod.
              - …
            - `podAffinity` object: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
              - …
            - `podAntiAffinity` object: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
              - …
          - `proxy` object: Proxy is the affinity configuration for the DB Proxy pods.
            - `nodeAffinity` object: Describes node affinity scheduling rules for the pod.
              - …
            - `podAffinity` object: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
              - …
            - `podAntiAffinity` object: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
              - …
        - `psmdb` object: PSMDB is the affinity configuration for the PSMDB DB clusters.
          - `configServer` object: ConfigServer is the affinity configuration for the DB Config Server pods.
            - `nodeAffinity` object: Describes node affinity scheduling rules for the pod.
              - …
            - `podAffinity` object: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
              - …
            - `podAntiAffinity` object: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
              - …
          - `engine` object: Engine is the affinity configuration for the DB Engine pods.
            - `nodeAffinity` object: Describes node affinity scheduling rules for the pod.
              - …
            - `podAffinity` object: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
              - …
            - `podAntiAffinity` object: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
              - …
          - `proxy` object: Proxy is the affinity configuration for the DB Proxy pods.
            - `nodeAffinity` object: Describes node affinity scheduling rules for the pod.
              - …
            - `podAffinity` object: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
              - …
            - `podAntiAffinity` object: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
              - …
        - `pxc` object: PXC is the affinity configuration for the PXC DB clusters.
          - `engine` object: Engine is the affinity configuration for the DB Engine pods.
            - `nodeAffinity` object: Describes node affinity scheduling rules for the pod.
              - …
            - `podAffinity` object: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
              - …
            - `podAntiAffinity` object: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
              - …
          - `proxy` object: Proxy is the affinity configuration for the DB Proxy pods.
            - `nodeAffinity` object: Describes node affinity scheduling rules for the pod.
              - …
            - `podAffinity` object: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
              - …
            - `podAntiAffinity` object: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
              - …
      - `engineType` 'pxc' | 'postgresql' | 'psmdb', required: EngineType is type of DB engine that this policy can be applied to.
    - `status` object: PodSchedulingPolicyStatus defines the observed state of PodSchedulingPolicy.
      - `inUse` boolean: InUse is a flag that indicates if the policy is used by any DB cluster.
      - `lastObservedGeneration` integer: LastObservedGeneration is the most recent generation observed for this PodSchedulingPolicy.
  - `metadata` object

## Other responses

- `400`: Unsuccessful operation
- `500`: Internal server error

## Changes

- **2025-05-19** `edeafc325979`: 1 info
  - endpoint added
- **2024-04-12** `dec31e5eea8e`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/openeverest/apis/openeverest-schema/changes/pod-scheduling-policies/get.md)

---

[API](https://skmtc.dev/openeverest/apis/openeverest-schema.md) - [All operations](https://skmtc.dev/openeverest/apis/openeverest-schema/llms.txt) - [OpenAPI document](https://skmtc.dev/openeverest/apis/openeverest-schema/revisions/46b19e13670b?raw)