API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Security TXT

Retrieves security.txt

client.securityTXT.get(SecurityTXTGetParams { zone_id } params, RequestOptionsoptions?): SecurityTXTGetResponse { acknowledgments, canonical, contact, 6 more }

GET/zones/{zone_id}/security-center/securitytxt

Updates security.txt

client.securityTXT.update(SecurityTXTUpdateParams { zone_id, acknowledgments, canonical, 7 more } params, RequestOptionsoptions?): SecurityTXTUpdateResponse { errors, messages, success }

PUT/zones/{zone_id}/security-center/securitytxt

Deletes security.txt

client.securityTXT.delete(SecurityTXTDeleteParams { zone_id } params, RequestOptionsoptions?): SecurityTXTDeleteResponse { errors, messages, success }

DELETE/zones/{zone_id}/security-center/securitytxt

ModelsExpand Collapse

SecurityTXTGetResponse { acknowledgments, canonical, contact, 6 more }

acknowledgments?: Array<string>

canonical?: Array<string>

contact?: Array<string>

enabled?: boolean

encryption?: Array<string>

expires?: string

formatdate-time

hiring?: Array<string>

policy?: Array<string>

preferred_languages?: string

SecurityTXTUpdateResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

SecurityTXTDeleteResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.