Skip to content
Start here

Security TXT

Retrieves security.txt
client.securityTXT.get(SecurityTXTGetParams { zone_id } params, RequestOptionsoptions?): SecurityTXTGetResponse { contact, expires, acknowledgments, 6 more }
GET/zones/{zone_id}/security-center/securitytxt
Updates security.txt
client.securityTXT.update(SecurityTXTUpdateParams { zone_id, contact, expires, 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 { contact, expires, acknowledgments, 6 more }

Configuration of the zone security.txt file

contact: Array<string>

Methods that researchers should use for reporting vulnerabilities. Can be a URI for an email address, phone number, or URL.

expires: string

RFC3339-formatted date and time string indicating the time that, after which, the contents of the security.txt file should be considered stale. It is recommended that this value is less than a year into the future.

formatdate-time
acknowledgments?: Array<string>

Link(s) to a page where security researchers are recognised for their reports.

canonical?: Array<string>

Canonical URI where the security.txt file is located.

enabled?: boolean

Whether or not to serve the security.txt file in this zone. If false, security.txt requests will pass through to the origin server.

encryption?: Array<string>

URI(s) pointing to a location where an encryption key that researchers should use for encrypted communications can be retrieved. The key itself must not appear in this field.

hiring?: Array<string>

Link(s) to any security-related job positions.

policy?: Array<string>

Link(s) to where a vulnerability disclosure policy is located.

preferred_languages?: string

Comma-separated list of natural languages that are preferred when submitting security reports. Language codes should be as defined in RFC5646.

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.