Skip to content

1.6-api-overview.md

Latest commit

 

History

History
48 lines (33 loc) · 1.63 KB

1.6-api-overview.md

File metadata and controls

48 lines (33 loc) · 1.63 KB
Raw

Use the API Safely

The Dashboard currently exposes API key and API documentation areas. The current documentation defines the actual endpoints, permissions, request formats, and limits.

Do not assume the API can manage external DNS records. DigitalPlat nameserver delegation and an external DNS provider's record API are separate systems.

Start Read-Only

Good first tasks include inventory and status checks supported by the current documentation.

Before any mutation:

  1. Read the current state.
  2. Compare it with the intended state.
  3. Display the exact proposed change.
  4. Require approval when external effects are significant.
  5. Send one request.
  6. Read the authoritative state again.

Do not automatically retry ambiguous registration, renewal, deletion, purchase, or nameserver operations.

Key Safety

  • Create a key for one purpose.
  • Use the narrowest available permission.
  • Store it in a protected secret system.
  • Never place it in frontend JavaScript, screenshots, URLs, or Git commits.
  • Rotate it after exposure or staff changes.
  • Delete unused keys.

Documentation Placeholder

This skeleton intentionally omits a real endpoint:

curl --fail-with-body \
  --connect-timeout 10 \
  --max-time 30 \
  --header "Authorization: Bearer $DIGITALPLAT_API_TOKEN" \
  --header "Accept: application/json" \
  "https://address-from-current-api-documentation.example/resource"

Copy current endpoint details only from the authenticated official API documentation.

Category Transition

You have completed the DigitalPlat-specific category. Continue to Category B: General Domain and Website Textbook.