Skip to content
Start here

Security TXT

Retrieves security.txt
GET/zones/{zone_id}/security-center/securitytxt
Updates security.txt
PUT/zones/{zone_id}/security-center/securitytxt
Deletes security.txt
DELETE/zones/{zone_id}/security-center/securitytxt
ModelsExpand Collapse
SecurityTXTGetResponse object { contact, expires, acknowledgments, 6 more }

Configuration of the zone security.txt file

contact: array of 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: optional array of string

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

canonical: optional array of string

Canonical URI where the security.txt file is located.

enabled: optional 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: optional array of 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: optional array of string

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

policy: optional array of string

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

preferred_languages: optional string

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

SecurityTXTUpdateResponse object { errors, messages, success }
errors: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
success: true

Whether the API call was successful.

SecurityTXTDeleteResponse object { errors, messages, success }
errors: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
success: true

Whether the API call was successful.