---
title: "Get origin groups list"
method: GET
path: "/cdn/origin_groups"
tags: ["Origins"]
---

# Get origin groups list

`GET /cdn/origin_groups`

Get all origin groups and related origin sources.

## Query parameters

- `name` string
- `sources` string
- `has_related_resources` boolean
- `limit` integer
- `offset` integer

## Response `200`

Successful.

- union
  - OriginGroupsResponse[]
    - union
      - object — Origin group with host origins, or mixed host and S3 origins using inline `origin_type` and `config` in sources.
        - `id` integer, required — Origin group ID.
        - `name` string, required — Origin group name.
        - `use_next` boolean — Defines whether to use the next origin from the origin group if origin responds with the cases specified in `proxy_next_upstream`. If you enable it, you must specify cases in `proxy_next_upstream`. Possible values: - **true** - Option is enabled. - **false** - Option is disabled.
        - `proxy_next_upstream` string[] — Defines cases when the request should be passed on to the next origin. Possible values: - **error** - an error occurred while establishing a connection with the origin, passing a request to it, or reading the response header - **timeout** - a timeout has occurred while establishing a connection with the origin, passing a request to it, or reading the response header - **`invalid_header`** - a origin returned an empty or invalid response - **`http_403`** - a origin returned a response with the code 403 - **`http_404`** - a origin returned a response with the code 404 - **`http_429`** - a origin returned a response with the code 429 - **`http_500`** - a origin returned a response with the code 500 - **`http_502`** - a origin returned a response with the code 502 - **`http_503`** - a origin returned a response with the code 503 - **`http_504`** - a origin returned a response with the code 504
        - `auth_type` string — **Deprecated.** No longer necessary. Defaults to `none`. Origin authentication type. Possible values: - **none** - Used for public origins. - **awsSignatureV4** - Used for S3 storage.
        - `sources` SourceResponse[], required — List of origin sources in the origin group. Each entry can be a host origin or an S3 origin. Host origins have a `source` field with the hostname or IP. S3 origins have `origin_type: s3` and a `config` object with S3 credentials. Both types can be mixed in the same origin group.
          - union
            - HostSourceResponse — A host origin source.
              - …
            - S3SourceResponse — An S3 origin source.
              - …
            - FastedgeSourceResponse — A FastEdge application origin source.
              - …
        - `path` string — **Deprecated.** No longer necessary. Omit this field and the default origin path behavior will be used. Origin path prefix.
        - `has_related_resources` boolean — Defines whether the origin group has related CDN resources. Possible values: - **true** - Origin group has related CDN resources. - **false** - Origin group does not have related CDN resources.
      - object — **Deprecated.** To create S3 origins, configure them directly in sources with `origin_type` and `config` instead.
        - `id` integer, required — Origin group ID.
        - `name` string, required — Origin group name.
        - `use_next` boolean — Defines whether to use the next origin from the origin group if origin responds with the cases specified in `proxy_next_upstream`. If you enable it, you must specify cases in `proxy_next_upstream`. Possible values: - **true** - Option is enabled. - **false** - Option is disabled.
        - `proxy_next_upstream` string[] — Defines cases when the request should be passed on to the next origin. Possible values: - **error** - an error occurred while establishing a connection with the origin, passing a request to it, or reading the response header - **timeout** - a timeout has occurred while establishing a connection with the origin, passing a request to it, or reading the response header - **`invalid_header`** - a origin returned an empty or invalid response - **`http_403`** - a origin returned a response with the code 403 - **`http_404`** - a origin returned a response with the code 404 - **`http_429`** - a origin returned a response with the code 429 - **`http_500`** - a origin returned a response with the code 500 - **`http_502`** - a origin returned a response with the code 502 - **`http_503`** - a origin returned a response with the code 503 - **`http_504`** - a origin returned a response with the code 504
        - `auth_type` string, required — **Deprecated.** To create S3 origins, configure them directly in sources with `origin_type` and `config` instead. Authentication type. **awsSignatureV4** value is used for S3 storage.
        - `auth` Auth, required — **Deprecated.** To create S3 origins, configure them directly in sources with `origin_type` and `config` instead. Credentials to access the private bucket.
          - `s3_type` string, required — Storage type compatible with S3. Possible values: - **amazon** – AWS S3 storage. - **other** – Other (not AWS) S3 compatible storage.
          - `s3_access_key_id` string, required — Access key ID for the S3 account. Restrictions: - Latin letters (A-Z, a-z), numbers (0-9), colon, dash, and underscore. - From 3 to 512 characters.
          - `s3_secret_access_key` string, required — Secret access key for the S3 account. Restrictions: - Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores. - If "s3_type": amazon, length should be 40 characters. - If "s3_type": other, length should be from 16 to 255 characters.
          - `s3_bucket_name` string, required — S3 bucket name.
          - `s3_storage_hostname` string — S3 storage hostname. The parameter is required, if "s3_type": other.
          - `s3_region` string — S3 storage region. The parameter is required, if "s3_type": amazon.
        - `path` string — **Deprecated.** No longer necessary. Omit this field and the default origin path behavior will be used. Origin path prefix.
        - `has_related_resources` boolean — Defines whether the origin group has related CDN resources. Possible values: - **true** - Origin group has related CDN resources. - **false** - Origin group does not have related CDN resources.
  - object
    - `count` integer, required — Total number of items.
    - `next` string, nullable, required — URL to the next page of results. Null if current page is the last one.
    - `previous` string, nullable, required — URL to the previous page of results. Null if current page is the first one.
    - `results` OriginGroupsResponse[], required — List of items on the current page.
      - union
        - object — Origin group with host origins, or mixed host and S3 origins using inline `origin_type` and `config` in sources.
          - `id` integer, required — Origin group ID.
          - `name` string, required — Origin group name.
          - `use_next` boolean — Defines whether to use the next origin from the origin group if origin responds with the cases specified in `proxy_next_upstream`. If you enable it, you must specify cases in `proxy_next_upstream`. Possible values: - **true** - Option is enabled. - **false** - Option is disabled.
          - `proxy_next_upstream` string[] — Defines cases when the request should be passed on to the next origin. Possible values: - **error** - an error occurred while establishing a connection with the origin, passing a request to it, or reading the response header - **timeout** - a timeout has occurred while establishing a connection with the origin, passing a request to it, or reading the response header - **`invalid_header`** - a origin returned an empty or invalid response - **`http_403`** - a origin returned a response with the code 403 - **`http_404`** - a origin returned a response with the code 404 - **`http_429`** - a origin returned a response with the code 429 - **`http_500`** - a origin returned a response with the code 500 - **`http_502`** - a origin returned a response with the code 502 - **`http_503`** - a origin returned a response with the code 503 - **`http_504`** - a origin returned a response with the code 504
          - `auth_type` string — **Deprecated.** No longer necessary. Defaults to `none`. Origin authentication type. Possible values: - **none** - Used for public origins. - **awsSignatureV4** - Used for S3 storage.
          - `sources` SourceResponse[], required — List of origin sources in the origin group. Each entry can be a host origin or an S3 origin. Host origins have a `source` field with the hostname or IP. S3 origins have `origin_type: s3` and a `config` object with S3 credentials. Both types can be mixed in the same origin group.
            - union
              - …
          - `path` string — **Deprecated.** No longer necessary. Omit this field and the default origin path behavior will be used. Origin path prefix.
          - `has_related_resources` boolean — Defines whether the origin group has related CDN resources. Possible values: - **true** - Origin group has related CDN resources. - **false** - Origin group does not have related CDN resources.
        - object — **Deprecated.** To create S3 origins, configure them directly in sources with `origin_type` and `config` instead.
          - `id` integer, required — Origin group ID.
          - `name` string, required — Origin group name.
          - `use_next` boolean — Defines whether to use the next origin from the origin group if origin responds with the cases specified in `proxy_next_upstream`. If you enable it, you must specify cases in `proxy_next_upstream`. Possible values: - **true** - Option is enabled. - **false** - Option is disabled.
          - `proxy_next_upstream` string[] — Defines cases when the request should be passed on to the next origin. Possible values: - **error** - an error occurred while establishing a connection with the origin, passing a request to it, or reading the response header - **timeout** - a timeout has occurred while establishing a connection with the origin, passing a request to it, or reading the response header - **`invalid_header`** - a origin returned an empty or invalid response - **`http_403`** - a origin returned a response with the code 403 - **`http_404`** - a origin returned a response with the code 404 - **`http_429`** - a origin returned a response with the code 429 - **`http_500`** - a origin returned a response with the code 500 - **`http_502`** - a origin returned a response with the code 502 - **`http_503`** - a origin returned a response with the code 503 - **`http_504`** - a origin returned a response with the code 504
          - `auth_type` string, required — **Deprecated.** To create S3 origins, configure them directly in sources with `origin_type` and `config` instead. Authentication type. **awsSignatureV4** value is used for S3 storage.
          - `auth` Auth, required — **Deprecated.** To create S3 origins, configure them directly in sources with `origin_type` and `config` instead. Credentials to access the private bucket.
            - `s3_type` string, required — Storage type compatible with S3. Possible values: - **amazon** – AWS S3 storage. - **other** – Other (not AWS) S3 compatible storage.
            - `s3_access_key_id` string, required — Access key ID for the S3 account. Restrictions: - Latin letters (A-Z, a-z), numbers (0-9), colon, dash, and underscore. - From 3 to 512 characters.
            - `s3_secret_access_key` string, required — Secret access key for the S3 account. Restrictions: - Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores. - If "s3_type": amazon, length should be 40 characters. - If "s3_type": other, length should be from 16 to 255 characters.
            - `s3_bucket_name` string, required — S3 bucket name.
            - `s3_storage_hostname` string — S3 storage hostname. The parameter is required, if "s3_type": other.
            - `s3_region` string — S3 storage region. The parameter is required, if "s3_type": amazon.
          - `path` string — **Deprecated.** No longer necessary. Omit this field and the default origin path behavior will be used. Origin path prefix.
          - `has_related_resources` boolean — Defines whether the origin group has related CDN resources. Possible values: - **true** - Origin group has related CDN resources. - **false** - Origin group does not have related CDN resources.

## Other responses

- `403` — You do not have permission to perform this action.

---

[API](https://skmtc.dev/g-core/apis/gcore-openapi.md) · [All operations](https://skmtc.dev/g-core/apis/gcore-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/g-core/gcore-openapi/revisions/09e652815095/schema)