# Schemas

## Retrieve operations and features as OpenAPI schemas

`api_gateway.schemas.list(SchemaListParams**kwargs)  -> SchemaListResponse`

**get** `/zones/{zone_id}/api_gateway/schemas`

Retrieve operations and features as OpenAPI schemas

### Parameters

- `zone_id: str`

  Identifier.

- `feature: Optional[List[Literal["thresholds", "parameter_schemas", "schema_info"]]]`

  Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.

  - `"thresholds"`

  - `"parameter_schemas"`

  - `"schema_info"`

- `host: Optional[SequenceNotStr[str]]`

  Receive schema only for the given host(s).

### Returns

- `class SchemaListResponse: …`

  - `schemas: Optional[List[object]]`

  - `timestamp: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
schemas = client.api_gateway.schemas.list(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(schemas.schemas)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "schemas": [
      {
        "info": {
          "title": "OpenAPI JSON schema for www.example.com",
          "version": "1.0"
        },
        "openapi": "3.0.0",
        "paths": {
          "... Further paths ...": {},
          "/api/v1/users/{var1}": {
            "get": {
              "parameters": [
                {
                  "in": "path",
                  "name": "var1",
                  "required": true,
                  "schema": {
                    "type": "string"
                  }
                }
              ]
            }
          }
        },
        "servers": [
          {
            "url": "www.example.com"
          }
        ]
      }
    ],
    "timestamp": "timestamp"
  },
  "success": true
}
```

## Domain Types

### Schema List Response

- `class SchemaListResponse: …`

  - `schemas: Optional[List[object]]`

  - `timestamp: Optional[str]`