Developers API reference Version 1 · generated from the code openapi.json
Routes

organisation

Ask for the check of a domain

POST /api/v1/organisation/domains/{domain_id}/verification

Ask for the check of a declared domain, once its TXT record is published. The domain is pending until it is verified.

Required scope: org:admin

Path parameters

  • domain_id integer · required

    Id of the domain.

Response

200 Domain

  • id integer

    Id of the domain.

  • domain string

    The domain name.

  • status string

    inactive: declared, its check not asked for yet. pending: check asked for. verified: checked; every account verified on the domain is then a root reader of the organisation.

  • record_name string

    Name of the DNS TXT record to publish.

  • record_value string

    Value of the DNS TXT record to publish.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 404

    Nothing with that id, or nothing the account may open.

  • 409

    The current state of the content forbids the request.

  • 422

    A value is missing or malformed.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt