Skip to content

Updates security.txt

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

Updates the security.txt file configuration for a zone, which provides security researchers with vulnerability reporting information.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Zone Settings Write

Path ParametersExpand Collapse

zone_id: string

Identifier.

maxLength32

Body ParametersJSONExpand Collapse

acknowledgments: optional array of string

canonical: optional array of string

contact: optional array of string

enabled: optional boolean

encryption: optional array of string

expires: optional string

formatdate-time

hiring: optional array of string

policy: optional array of string

preferred_languages: optional string

ReturnsExpand Collapse

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.

Updates security.txt

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/security-center/securitytxt \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "acknowledgments": [
            "https://example.com/hall-of-fame.html"
          ],
          "canonical": [
            "https://www.example.com/.well-known/security.txt"
          ],
          "contact": [
            "mailto:security@example.com",
            "tel:+1-201-555-0123",
            "https://example.com/security-contact.html"
          ],
          "enabled": true,
          "encryption": [
            "https://example.com/pgp-key.txt",
            "dns:5d2d37ab76d47d36._openpgpkey.example.com?type=OPENPGPKEY",
            "openpgp4fpr:5f2de5521c63a801ab59ccb603d49de44b29100f"
          ],
          "hiring": [
            "https://example.com/jobs.html"
          ],
          "policy": [
            "https://example.com/disclosure-policy.html"
          ],
          "preferred_languages": "en, es, fr"
        }'

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true
}