Skip to content
Start here

User Schemas

Retrieve information about all schemas on a zone
Deprecated
client.APIGateway.UserSchemas.List(ctx, params) (*V4PagePaginationArray[OldPublicSchema], error)
GET/zones/{zone_id}/api_gateway/user_schemas
Retrieve information about a specific schema on a zone
Deprecated
client.APIGateway.UserSchemas.Get(ctx, schemaID, params) (*OldPublicSchema, error)
GET/zones/{zone_id}/api_gateway/user_schemas/{schema_id}
Upload a schema to a zone
Deprecated
client.APIGateway.UserSchemas.New(ctx, params) (*UserSchemaNewResponse, error)
POST/zones/{zone_id}/api_gateway/user_schemas
Enable validation for a schema
Deprecated
client.APIGateway.UserSchemas.Edit(ctx, schemaID, params) (*OldPublicSchema, error)
PATCH/zones/{zone_id}/api_gateway/user_schemas/{schema_id}
Delete a schema
Deprecated
client.APIGateway.UserSchemas.Delete(ctx, schemaID, body) (*UserSchemaDeleteResponse, error)
DELETE/zones/{zone_id}/api_gateway/user_schemas/{schema_id}
ModelsExpand Collapse
type Message []MessageItem
Code int64
minimum1000
Message string
DocumentationURL stringoptional
Source MessageItemSourceoptional
Pointer stringoptional
type OldPublicSchema struct{…}
CreatedAt Time
formatdate-time
Kind OldPublicSchemaKind

Kind of schema

Name string

Name of the schema

SchemaID string

UUID.

maxLength36
minLength36
Source stringoptional

Source of the schema

ValidationEnabled booloptional

Flag whether schema is enabled for validation.

User SchemasOperations

Retrieve all operations from a schema.
Deprecated
client.APIGateway.UserSchemas.Operations.List(ctx, schemaID, params) (*V4PagePaginationArray[UserSchemaOperationListResponse], error)
GET/zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations

User SchemasHosts

Retrieve schema hosts in a zone
Deprecated
client.APIGateway.UserSchemas.Hosts.List(ctx, params) (*V4PagePaginationArray[UserSchemaHostListResponse], error)
GET/zones/{zone_id}/api_gateway/user_schemas/hosts