Authentication

Create Api Key

Request a new API key.

Default keys are valid for one year

post/auth/apikey

Request

  • Base URL: https://data-api.globalforestwatch.org (the document declares no server; this is the origin it was published from)
  • URL: https://data-api.globalforestwatch.org/auth/apikey
  • Auth: OAuth 2 (password, token URL /token)

Request body

aliasstring required

Nickname for API Key

organizationstring required

Name of organization or website

emailstring email required

Email address of POC

domainsstring[]

List of domains which can be used this API key. If no domain is listed, the key will be set by default to the lowest rate limiting tier. <br/> When making request using the API key, make sure you add the correct origin header matching a domain in this allowlist.<br/><br/> You can use wildcards for subdomains such as *.yourdomain.com.<br/> Our validation method for wildcards will allow only subdomains.<br/><br/> Make sure you also add yourdomain.com if you use root without any subdomains.<br/> www.yourdomain.com and yourdomain.com are two different domains in terms of security.<br/> Include www. if required.<br/><br/> Do not include port numbers in the domain names. localhost:3000<br/><br/> A domains example for local development might look like this:<br/> ["www.yourdomain.com", "*.yourdomain.com", "yourdomain.com", "localhost"]

never_expiresboolean

Set API Key to never expire, only admin users can set this to true

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.