Skip to content
Start here

Security TXT

Retrieves security.txt
security_txt.get(SecurityTXTGetParams**kwargs) -> SecurityTXTGetResponse
GET/zones/{zone_id}/security-center/securitytxt
Updates security.txt
security_txt.update(SecurityTXTUpdateParams**kwargs) -> SecurityTXTUpdateResponse
PUT/zones/{zone_id}/security-center/securitytxt
Deletes security.txt
security_txt.delete(SecurityTXTDeleteParams**kwargs) -> SecurityTXTDeleteResponse
DELETE/zones/{zone_id}/security-center/securitytxt
ModelsExpand Collapse
class SecurityTXTGetResponse: …

Configuration of the zone security.txt file

contact: List[str]

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

expires: datetime

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[List[str]]

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

canonical: Optional[List[str]]

Canonical URI where the security.txt file is located.

enabled: Optional[bool]

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[List[str]]

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[List[str]]

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

policy: Optional[List[str]]

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

preferred_languages: Optional[str]

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

class SecurityTXTUpdateResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

class SecurityTXTDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.