API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Snippets

List zone snippets

client.snippets.list(SnippetListParams { zone_id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<SnippetListResponse { created_on, snippet_name, modified_on } >

GET/zones/{zone_id}/snippets

Get a zone snippet

client.snippets.get(stringsnippetName, SnippetGetParams { zone_id } params, RequestOptionsoptions?): SnippetGetResponse { created_on, snippet_name, modified_on }

GET/zones/{zone_id}/snippets/{snippet_name}

Update a zone snippet

client.snippets.update(stringsnippetName, SnippetUpdateParams { zone_id, metadata } params, RequestOptionsoptions?): SnippetUpdateResponse { created_on, snippet_name, modified_on }

PUT/zones/{zone_id}/snippets/{snippet_name}

Delete a zone snippet

client.snippets.delete(stringsnippetName, SnippetDeleteParams { zone_id } params, RequestOptionsoptions?): SnippetDeleteResponse | null

DELETE/zones/{zone_id}/snippets/{snippet_name}

ModelsExpand Collapse

SnippetListResponse { created_on, snippet_name, modified_on }

Define a snippet.

created_on: string

Indicates when the snippet was created.

formatdate-time

snippet_name: string

Identify the snippet.

modified_on?: string

Indicates when the snippet was last modified.

formatdate-time

SnippetGetResponse { created_on, snippet_name, modified_on }

Contain the response result.

created_on: string

Indicates when the snippet was created.

formatdate-time

snippet_name: string

Identify the snippet.

modified_on?: string

Indicates when the snippet was last modified.

formatdate-time

SnippetUpdateResponse { created_on, snippet_name, modified_on }

Contain the response result.

created_on: string

Indicates when the snippet was created.

formatdate-time

snippet_name: string

Identify the snippet.

modified_on?: string

Indicates when the snippet was last modified.

formatdate-time

SnippetDeleteResponse = unknown

Contain the response result.

SnippetsContent

Get a zone snippet content

client.snippets.content.get(stringsnippetName, ContentGetParams { zone_id } params, RequestOptionsoptions?): Response

GET/zones/{zone_id}/snippets/{snippet_name}/content

SnippetsRules

List zone snippet rules

client.snippets.rules.list(RuleListParams { zone_id } params, RequestOptionsoptions?): RuleListResponse

GET/zones/{zone_id}/snippets/snippet_rules

Update zone snippet rules

client.snippets.rules.update(RuleUpdateParams { zone_id, rules } params, RequestOptionsoptions?): RuleUpdateResponse

PUT/zones/{zone_id}/snippets/snippet_rules

Delete zone snippet rules

client.snippets.rules.delete(RuleDeleteParams { zone_id } params, RequestOptionsoptions?): RuleDeleteResponse

DELETE/zones/{zone_id}/snippets/snippet_rules

ModelsExpand Collapse

RuleListResponse = unknown

Contain the response result.

RuleUpdateResponse = unknown

Contain the response result.

RuleDeleteResponse = unknown

Contain the response result.