Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Dtn Possible SIGMET FIR names API
version: '1.0'
description: 'Operations tagged Possible SIGMET FIR names across 2 of this provider''s published API definitions: dtn-sigmets-airmets-openapi.json, dtn-websocket-api-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://aviation.api.dtn.com
security:
- clientCredentials: []
tags:
- name: Possible SIGMET FIR names
description: List of possible FIR names that may be used with firNames parameter for SIGMET requests via API
paths:
/v1/possibleFirNames/:
get:
tags:
- Possible SIGMET FIR names
summary: Get possible SIGMET FIR names that might be represented in data response
description: Get FIR names that may provide data if used with 'firNames' parameter. May filtered by certain query parameters. All specified filter parameters must be satisfied for an object to be returned in the response.
responses:
'200':
$ref: '#/components/responses/PossibleFirNameSuccess'
'400':
$ref: '#/components/responses/SigmetBadRequest'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
parameters:
- $ref: '#/components/parameters/QueryOffset'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryBbox'
- $ref: '#/components/parameters/QueryPolygon'
- $ref: '#/components/parameters/QueryCircle'
- $ref: '#/components/parameters/QueryCorridor'
- $ref: '#/components/parameters/QuerySrid'
- $ref: '#/components/parameters/QueryDistanceUnits'
- $ref: '#/components/parameters/QueryFirs'
- $ref: '#/components/parameters/QueryFirStartsWith'
security:
- clientCredentials: []
servers:
- url: https://aviation.api.dtn.com
components:
responses:
SigmetBadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
BadRequest:
$ref: '#/components/examples/SigmetBadRequestResponse'
PossibleFirNameSuccess:
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/PossibleFirNamesList'
examples:
Success:
$ref: '#/components/examples/PossibleFirNameSuccessResponse'
ErrorUnauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: unauthorized
title: Error while authenticating the user
status: 401
detail: Missing Authorization token.
instance: urn:dtn:aviation-api:/v1/notams/KIND:requestId:19e1b83a-cb2e-4460-b687-ce9d0c50b4b6
meta:
name: v1.notams.KIND
uuid: d64fc634-9bee-430d-8ab1-200337e6e9b2
request_id: 19e1b83a-cb2e-4460-b687-ce9d0c50b4b6
start_timestamp: 1714019217213
end_timestamp: 1714019217246
execution_time: 33
schemas:
Meta:
title: Meta
description: Meta data attached to every response
required:
- name
- request_id
- start_timestamp
- end_timestamp
- execution_time
type: object
properties:
name:
type: string
request_id:
type: string
start_timestamp:
type: integer
end_timestamp:
type: integer
execution_time:
type: integer
PossibleFirNamesList:
type: object
properties:
url:
type: string
possibleFirNames:
type: array
items:
type: string
meta:
$ref: '#/components/schemas/Meta'
Error:
title: Error
description: Error
required:
- type
- title
- status
- detail
- meta
type: object
properties:
url:
type: string
type:
enum:
- internal-server-error
- unauthorized
- bad-request
- service-unavailable
- forbidden
- not-found
type: string
title:
type: string
status:
type: number
detail:
type: string
instance:
type: string
errors:
type: array
items:
type: object
meta:
$ref: '#/components/schemas/Meta'
PossibleFirNamesList_2:
type: object
properties:
url:
type: string
possibleFirNames:
type: array
meta:
$ref: '#/components/schemas/Meta'
parameters:
QueryFirs:
name: firs
description: Comma-separated list of FIR names values. Values must exactly match items in defined population. Limits to objects whose `firStandardName` value matches one of specified parameter values.
in: query
required: false
schema:
type: string
QueryPolygon:
name: polygon
description: Polygon coordinates in the format `<X_0>,<Y_0>,<X_1>,<Y_1>...,<X_n>,<Y_n>`. The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default). Must provide between 3 and 40 coordinates. If the last `X,Y` does not match the first `X,Y`, the first `X,Y` is copied to the end to close the polygon. Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request. Requests with polygon definition of area that crosses antimeridian will fail or give unexpected results.
in: query
required: false
schema:
type: string
QueryFirStartsWith:
name: firStartsWith
description: Beginning characters of FIR name. Must be between 2 and 10 characters and only letters, spaces, dashes, and apostrophes allowed. Results will be provided including data for any FIRs whose `firStandardName` values match the input, like for both `GUANGZHOU` and `GUAYAQUIL` if provide `GUA` as value.
in: query
required: false
schema:
type: string
QueryLimit:
name: limit
description: Provide no more than this many items in the response set.
in: query
required: false
schema:
type: integer
default: 1000
minimum: 1
maximum: 10000
QueryCorridor:
name: corridor
description: Line coordinates and distance from the line in the format `<X_0>,<Y_0>,<X_1>,<Y_1>...,<X_n>,<Y_n>,<HALFWIDTH>`. The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default). Must provide between 2 and 40 coordinates for the line. The `<HALFWIDTH>` defines the distance (in default or `distanceUnits`-specified units) from the line defined by the coordinates out to which to create encompassing shape. Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request. Requests with corridor definition of area that crosses antimeridian will fail or give unexpected results. The larger the defined area, the more its shape on projected map will differ from true corridor on spherical coordinates. Maximum allowed <HALFWIDTH> is 200nm (and equal lengths for different `distanceUnits`).
in: query
required: false
schema:
type: string
QuerySrid:
name: srid
description: SRID Identifier for coordinate system for spatial filter coordinates. Default is 4326 (i.e., ordinary longitude & latitude in degrees).
in: query
required: false
explode: false
schema:
type: integer
enum:
- 4326
- 3857
default: 4326
QueryOffset:
name: offset
description: Skip over this many into the response set; used for paginated results.
in: query
required: false
schema:
type: integer
default: 0
QueryCircle:
name: circle
description: Circle coordinates and radius distance in the format `<X>,<Y>,<RADIUS>`. The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default). The `<RADIUS>` defines the distance (in default or `distanceUnits`-specified units) from the defined point. Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request. Requests with circle definition of area that crosses antimeridian will fail. The larger the defined area, the more its shape on projected map will differ from true circle on spherical coordinates. Maximum allowed <RADIUS> is 400nm (and equal lengths for different `distanceUnits`).
in: query
required: false
schema:
type: string
QueryDistanceUnits:
name: distanceUnits
description: Units identifier for distances in definition for circle or corridor spatial filter. Default is `nm` (nautical miles).
in: query
required: false
schema:
type: string
enum:
- nm
- km
- m
- sm
default: nm
QueryBbox:
name: bbox
description: Bounding box coordinates in the format `<min_X>,<min_Y>,<max_X>,<max_Y>`. The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default). Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request. Requests with bbox definition of area that crosses antimeridian will fail.
in: query
required: false
schema:
type: string
examples:
PossibleFirNameSuccessResponse:
value:
url: https://aviation.api.dtn.com/v1/possibleFirNames/
possibleFirNames:
- ACCRA FIR
- ADDIS ABABA FIR
- AKTOBE FIR
- ALBUQUERQUE ARTCC
- ALGIERS FIR
- ALMATY FIR
- AMAZONICA FIR
- AMMAN FIR
- AMSTERDAM FIR
- ANCHORAGE ARCTIC FIR
- ANCHORAGE ARTCC LOW
- ANCHORAGE CONTINENTAL FIR
- ANCHORAGE OCEANIC FIR
- ANKARA FIR
- ANTANANARIVO FIR/UIR
- ANTOFAGASTA FIR
- ASHGABAT FIR
- ASMARA FIR
- ASTANA FIR
- ASUNCION FIR
- ATHENS FIR/HELLAS UIR
- ATLANTA ARTCC
- ATLANTICO FIR/UIR
- AUCKLAND OCEANIC FIR
- BAGHDAD FIR
- BAHRAIN FIR
- BAKU FIR
- BANGKOK FIR
- BARCELONA FIR/UIR
- BARRANQUILLA FIR
- BEIJING FIR
- BEIRA FIR
- BEIRUT FIR/UIR
- BELGRADE FIR
- BISHKEK FIR
- BODO OCEANIC FIR
- BOGOTA FIR
- BORDEAUX FIR
- BOSTON ARTCC
- BRASILIA FIR
- BRATISLAVA FIR
- BRAZZAVILLE FIR/UIR
- BREMEN FIR
- BREST FIR
- BRINDISI FIR/UIR
- BRISBANE FIR
- BRUSSELS FIR
- BUCHAREST FIR
- BUDAPEST FIR
- BUJUMBURA FIR
- CAIRO FIR
- CANARIES FIR
- CAPE TOWN FIR
- CASABLANCA FIR
- CAYENNE FIR
- CENTRAL AMERICA FIR
- CHENNAI FIR
- CHICAGO ARTCC
- CHISINAU FIR
- CLEVELAND ARTCC
- COLOMBO FIR
- COMODORO RIVADAVIA FIR
- COPENHAGEN FIR
- CORDOBA FIR
- CURACAO FIR/UIR
- CURITIBA FIR
- DAKAR FIR
- DAKAR OCEANIC FIR
- DAMASCUS FIR
- DAR ES SALAAM FIR
- DASHOGUZ FIR
- DELHI FIR
- DENVER ARTCC
- DHAKA FIR
- DNIPRO FIR
- DOHA FIR
- DUSHANBE FIR
- EDMONTON FIR
- EMIRATES FIR
- ENTEBBE FIR
- EZEIZA FIR
- FORT WORTH ARTCC
- FUKUOKA FIR
- GABORONE FIR
- GANDER DOMESTIC FIR
- GANDER OCEANIC FIR
- GEORGETOWN FIR/UIR
- GUAM CERAP
- GUANGZHOU
- GUAYAQUIL FIR
- HANOI FIR
- HARARE FIR/UIR
- HAVANA FIR/UIR
- HELSINKI FIR
- HO CHI MINH FIR
- HONG KONG
- HONIARA FIR
- HONOLULU ARTCC
- HOUSTON ARTCC
- HOUSTON OCEANIC FIR
- INCHEON FIR
- INDIANAPOLIS ARTCC
- IRKUTSK FIR
- ISLA DE PASCUA FIR
- ISTANBUL FIR
- JACKSONVILLE ARTCC
- JAKARTA FIR
- JEDDAH FIR
- JOHANNESBURG FIR
- JOHANNESBURG OCEANIC FIR
- JUBA FIR
- KABUL FIR
- KALININGRAD FIR
- KANO FIR
- KANSAS CITY ARTCC
- KARACHI FIR
- KATHMANDU FIR
- KHABAROVSK FIR
- KHARTOUM FIR
- KIGALI FIR/UIR
- KINGSTON FIR
- KINSHASA FIR
- KOLKATA FIR
- KOTA KINABALU FIR
- KRASNOYARSK FIR
- KUALA LUMPUR FIR
- KUNMING FIR
- KUWAIT FIR
- KYIV FIR
- LAHORE FIR
- LANGEN FIR
- LANZHOU FIR
- LA PAZ FIR
- LILONGWE FIR
- LIMA FIR
- LISBON FIR
- LJUBLJANA FIR
- LONDON FIR/UIR
- LOS ANGELES ARTCC
- LUANDA FIR
- LUSAKA FIR
- LVIV FIR
- MADRID FIR/UIR
- MAGADAN FIR
- MAIQUETIA FIR
- MALE FIR
- MALTA FIR/UIR
- MANILA FIR
- MARSEILLE FIR
- MAURITIUS FIR
- MAZATLAN OCEANIC FIR
- MELBOURNE FIR
- MEMPHIS ARTCC
- MENDOZA FIR
- MEXICO FIR
- MIAMI ARTCC
- MIAMI OCEANIC FIR
- MILAN FIR/UIR
- MINNEAPOLIS ARTCC
- MINSK FIR
- MOGADISHU FIR
- MONCTON FIR
- MONTEVIDEO FIR
- MONTREAL FIR
- MOSCOW FIR
- MUMBAI FIR
- MUNICH FIR
- MUSCAT FIR
- NADI FIR
- NAIROBI FIR
- NASSAU FIR
- NAURU FIR
- NDJAMENA FIR/UIR
- NEW YORK ARTCC
- NEW YORK OCEANIC FIR
- NEW ZEALAND FIR
- NIAMEY FIR/UIR
- NICOSIA FIR
- NO FIR
- NO FIR
- NOVOSIBIRSK FIR
- NUUK FIR
- OAKLAND ARTCC
- OAKLAND OCEANIC FIR
- ODESA FIR
- OSH FIR
- PANAMA FIR
- PARAMARIBO FIR
- PARIS FIR
- PHNOM PENH FIR
- PIARCO FIR
- POLARIS FIR
- PORT AU PRINCE FIR
- PORT MORESBY FIR
- PRAGUE FIR
- PUERTO MONTT FIR
- PUNTA ARENAS FIR
- PYONGYANG FIR
- RECIFE FIR
- REIMS FIR
- RESISTENCIA FIR
- REYKJAVIK FIR
- RIGA FIR
- ROBERTS FIR
- ROME FIR/UIR
- ROSTOV-NA-DONU FIR
- SAL OCEANIC FIR/UIR
- SALT LAKE ARTCC
- SAMARA FIR
- SAMARKAND FIR
- SANAA FIR
- SAN JUAN OCEANIC FIR
- SANKT-PETERBURG FIR
- SANTA MARIA OCEANIC FIR
- SANTIAGO FIR
- SANTO DOMINGO FIR
- SANYA FIR
- SARAJEVO FIR
- SCOTTISH FIR/UIR
- SEATTLE ARTCC
- SEYCHELLES FIR
- SHANGHAI FIR
- SHANNON FIR/UIR
- SHANWICK OCEANIC FIR
- SHENYANG FIR
- SHYMKENT FIR
- SIMFEROPOL FIR
- SINGAPORE FIR
- SKOPJE FIR
- SOFIA FIR
- SWEDEN FIR
- SWITZERLAND FIR/UIR
- TAHITI FIR
- TAIPEI FIR
- TALLINN FIR
- TASHKENT FIR
- TBILISI FIR
- TEHRAN FIR
- TEL AVIV FIR
- TIRANA FIR
- TORONTO FIR
- TRIPOLI FIR
- TUNIS FIR/UIR
- TURKMENABAT FIR
- TURKMENBASHI FIR
- TYUMEN FIR
- UJUNG PANDANG FIR
- ULAANBAATAR FIR
- URUMQI FIR
- VANCOUVER FIR
- VIENNA FIR
- VIENTIANE FIR
- VILNIUS FIR
- WARSAW FIR
- WASHINGTON ARTCC
- WINDHOEK FIR
- WINNIPEG FIR
- WUHAN FIR
- YAKUTSK FIR
- YANGON FIR
- YEKATERINBURG FIR
- YEREVAN FIR
- ZAGREB FIR
meta:
name: v1.possibleFirNames
uuid: 88e24e0f-9ce4-42cb-8ef8-c9bd4b14cd99
request_id: 86794145-31bd-4116-a498-acd8201cd41f
start_timestamp: 1748458784850
end_timestamp: 1748458787562
execution_time: 2712
SigmetBadRequestResponse:
value:
url: https://aviation.api.dtn.com/v1/sigmets?reportTypes=TURB,ST
type: bad-request
title: Invalid Request
status: 400
detail: Validation failed.
instance: urn:dtn:aviation-api:/v1/sigmets/:requestId:fa051103-4844-4012-822b-dfb651cb42e7
errors:
- message: Parameter value includes unpermitted characters or is otherwise not allowed
parameter: reportTypes
value: TURB,ST
meta:
name: v1.sigmets?reportTypes=TURB,ST
uuid: aaa1d697-6dfc-47f9-be23-f0a103330eb0
request_id: fa051103-4844-4012-822b-dfb651cb42e7
start_timestamp: 1721860434569
end_timestamp: 1721860434576
execution_time: 7
PossibleFirNameSuccessResponse_2:
value:
url: https://aviation.api.dtn.com/v1/possibleFirNames/
possibleFirNames:
- ACCRA
- ADDIS ABABA
- ADDIS ABEBA
- AKTOBE
- ALBUQUERQUE
- ALGER-FIR
- ALMATY
- AMAZONICA
- AMMAN
- AMSTERDAM
- ANCHORAGE
- ANCHORAGE ARCTIC
- ANCHORAGE OCEANIC
- ANKARA
- ANTANANARIVO
- ANTOFAGASTA
- ARKHANGELSK
- ARKHANGELSK-UIR
- ASHGABAT-FIR
- ASMARA
- ASUNCION
- ATHINAI
- ATLANTA
- ATLANTICO
- AUCKLAND OCEANIC
- BAGHDAD
- BAHRAIN FIR
- BAKU
- BAKU SOUTH SECTOR
- BANGKOK
- BARCELONA
- BARRANQUILLA
- BEIJING
- BEIRA
- BEIRUT
- BEOGRAD
- BERMUDA
- BISHKEK
- BODO OCEANIC
- BOGOTA
- BORDEAUX
- BOSTON
- BRASILIA
- BRATISLAVA
- BRAZZAVILLE
- BREMEN-FIR
- BREST
- BRINDISI
- BRISBANE
- BRUSSELS-FIR
- BRUSSELS-UIR
- BUCURESTI
- BUDAPEST
- BUJUMBURA
- CAIRO
- CANARIES FIR
- CANARIES UIR
- CAPE TOWN
- CASABLANCA
- CAYENNE
- CENTRAL AMERICA
- CHELYABINSK
- CHENNAI
- CHICAGO
- CHISINAU
- CHITA
- CHULMAN
- CLEVELAND
- COLOMBO
- COMODORO RIVADAVIA
- CORDOBA
- CURACAO
- CURITIBA
- DAKAR OCEANIQUE
- DAKAR TERRESTRE FIR
- DAKAR TERRESTRE UIR
- DAMASCUS
- DAR ES SALAAM FIR
- DAR ES SALAAM UIR
- DASHOGUZ-FIR
- DELHI
- DENVER
- DHAKA
- DNIPRO FIR
- DNIPROPETROVS'K
- DNIPROPETROVS'K FIR
- DOHA FIR
- DUSHANBE
- EAST TIMOR
- EDMONTON
- EMIRATES
- ENTEBBE
- EZEIZA
- FIJI DOMESTIC FIR (NFFJ)
- FINLAND
- FORT WORTH
- FRANCE
- FUKUOKA
- GABERONE
- GABORONE
- GANDER
- GANDER OCEANIC
- GEORGETOWN
- GUANGZHOU
- GUAYAQUIL
- HA NOI
- HABANA
- HANNOVER-UIR
- HARARE
- HELSINKI
- HO CHI MINH
- HONG KONG
- HONIARA
- HONOLULU
- HOUSTON
- HOUSTON OCEANIC
- INCHEON
- INDIANAPOLIS
- IRKUTSK
- ISTANBUL
- JACKSONVILLE
- JAKARTA
- JEDDAH
- JOHANNESBURG
- JOHANNESBURG OCEANIC
- KABUL
- KALININGRAD
- KAMENNY-MYS
- KANO
- KANSAS CITY
- KARACHI
- KATHMANDU
- KAZAN
- KHABAROVSK
- KHANTY-MANSIYSK
- KHARTOUM
- KHUJAND
- KIGALI
- KINGSTON
- KINSHASA
- KIROV
- KOBENHAVN
- KOLKATA
- KOTA KINABALU
- KOTLAS
- KRASNOYARSK
- KUALA LUMPUR
- KUNMING
- KUWAIT
- KYIV
- KYIV FIR
- KYIV UIR
- L'VIV
- L'VIV FIR
- LA PAZ
- LAHORE
- LANGEN FIR
- LANZHOU
- LESHUKONSKOYE-FIR
- LILONGWE FIR
- LILONGWE UIR
- LIMA
- LISBOA
- LJUBLJANA
- LONDON
- LOS ANGELES
- LUANDA
- LUSAKA
- MACAO
- MADRID
- MAGADAN OCEANIC
- MAGADAN-FIR
- MAGADAN-UIR
- MAGNITOGORSK
- MAIQUETIA
- MALE
- MALTA
- MANILA
- MARSEILLE
- MAURITIUS
- MAZATLAN OCEANIC
- MELBOURNE
- MEMPHIS
- MENDOZA
- MEXICO
- MIAMI
- MIAMI OCEANIC
- MILANO
- MILKOVO
- MINNEAPOLIS
- MINSK
- MIRNY
- MOGADISHU
- MONCTON
- MONTEVIDEO
- MONTREAL
- MOSCOW
- MUMBAI
- MUNCHEN-FIR
- MURMANSK
- MURMANSK OCEANIC
- MUSCAT
- N'DJAMENA
- NADI
- NAIROBI FIR
- NAIROBI UIR
- NARYAN-MAR
- NASSAU
- NAURU
- NEW YORK
- NEW YORK HIGH
- NEW YORK OCEANIC
- NEW ZEALAND
- NIAMEY
- NICOSIA
- NORILSK
- NOVOSIBIRSK
- NOVOSIBIRSK UIR
- NUKUS
- NUR SULTAN
- NUUK
- OAKLAND
- OAKLAND OCEANIC
- ODESA
- ODESA FIR
- OLEKMINSK
- OMSK
- OMSK UIR
- ORENBURG
- OSH
- OSSORA
- PANAMA
- PARAMARIBO
- PARIS
- PERM
- PETROPAVLOVSK KAMCHATSKY
- PHNOM PENH
- PIARCO
- POLARIS
- POLIARNY
- PORT AU PRINCE
- PORT MORESBY
- PRAHA
- PUERTO MONTT
- PUNTA ARENAS
- PYONGYANG
- RECIFE
- REIMS
- RESISTENCIA
- REYKJAVIK
- RHEIN-UIR
- RIGA
- ROBERTS
- ROMA
- ROSTOV-NA-DONU
- SAL OCEANIC
- SALEKHARD
- SALT LAKE CITY
- SAMARA
- SAMARKAND
- SAN JUAN OCEANIC
- SANAA
- SANKT-PETERBURG
- SANTA MARIA
- SANTIAGO
- SANTO DOMINGO
- SANYA AOR
- SARAJEVO
- SCOTTISH
- SEATTLE
- SEYCHELLES
- SHANGHAI
- SHANNON
- SHANWICK
- SHENYANG
- SHYMKENT
- SIMFEROPOL
- SIMFEROPOL FIR
- SINGAPORE
- SKOPJE
- SOFIA
- SONDRESTROM
- SURGUT
- SWEDEN
- SWITZERLAND
- SYKTYVKAR
- TAHITI
- TAIPEI
- TALLINN
- TARKO-SALE
- TASHKENT
- TBILISI
- TEHRAN
- TEL AVIV
- TIKSI
- TIKSI LOWER
- TIRANA
- TORONTO
- TRIPOLI FIR
- TRIPOLI UIR
- TUNIS-FIR
- TUNIS-UIR
- TURKMENABAT-FIR
- TURKMENBASHI-FIR
- TYUMEN
- UFA
- UJUNG PANDANG FIR
- UJUNG PANDANG UIR
- ULAANBAATAR
- UNKNOWNFIR
- URUMQI
- UST-KAMCHATSK
- VANCOUVER
- VIENTIANE
- VILNIUS
- VOLOGDA
- VUELO ISLA DE PASCUA
- WARSZAWA
- WASHINGTON
- WIEN
- WINDHOEK
- WINNIPEG
- WUHAN
- YAKUTSK
- YANGON
- YEKATERINBURG
- YEREVAN
- ZAGREB
meta:
name: v1.possibleFirNames
uuid: 9fdccdf5-da43-47a7-8307-b3496a7324fe
request_id: bb157977-cff3-452b-ae2f-10819d4b9310
start_timestamp: 1724442333507
end_timestamp: 1724442333631
execution_time: 124
securitySchemes:
clientCredentials:
type: oauth2
x-receive-token-in: request-body
flows:
clientCredentials:
tokenUrl: https://api.auth.dtn.com/v1/tokens/authorize
description: "# Using DAIS for M2M/API Auth\nYou have been given a Client ID and a Client Secret, which are used to request a DTN Access Token. DTN Access Tokens are required when making calls to each and every DTN API endpoint. The following information provides additional details on these tokens and how they are generated.\n## What is an Access Token and how is it different from an API Key?\nAn API Key is a random string of characters that an API uses to authorize whether or not a calling client has approved access to an endpoint. These keys are a non-standard approach to API authorization and are generally issued on a per-API basis.\n\nAn Access Token is also a string of characters but is a base-64 encoded JavaScript Object Notation Web Token, or JWT. JWTs are a widely accepted standard that use OAuth concepts and approaches. \n\nBoth API Keys and Access Tokens are used in an Authorization Request Header as a Bearer, meaning there is no difference in where you put this string of characters when you make calls to DTN APIs.\n## How to generate an Access Token?\nWhen requested, an Access Token is generated for your specific Client (ID/Secret) and for a specific API. The DTN Auth and Identity Service (DAIS) generates new Access Tokens for your client. The DAIS endpoint is `POST https://api.auth.dtn.com/v1/tokens/authorize`.\n\nThis endpoint takes two Header parameters:\n * `Content-Type: application/json`\n * `Accept: application/json`\n\nThis endpoint takes four parameters in the Request Body:\n * `grant_type`: this should always be client_credentials for generating machine-to-machine tokens.\n * `client_id`: this is the Client ID or Application ID using the token and is given to you by DTN's Identity Team. This ID will never change for your client/application.\n * `client_secret`: this is the Client Secret that is associated with the Application ID and is given to you by DTN's Identity Team. This key is subject to rotation for security purposes but always with the client's knowledge.\n * `audience`: this is the API for which this Access Token will be used. For the DTN SIGMETs/AIRMETs API, you need to use the following audience: https://aviation.api.dtn.com\n\nYou can use this CURL command template as a reference for obtaining an access token:\n ```\n curl --location --request POST 'https://api.auth.dtn.com/v1/tokens/authorize' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\"grant_type\": \"client_credentials\",\n\"client_id\": \"insert your client id here\",\n\"client_secret\": \"insert your client secret here\",\n\"audience\": \"insert your audience here\"\n}' \n ```\n\n*This document, for demonstration purposes, supplies a client_id and client_secret in all code examples. This client/application is for a fictitious API and cannot be used in practice to gain unauthorized access to any other DTN API.*\nUpon generating a new Access Token, you should receive an HTTP Response from DAIS similar to this:\n ```\n {\n \"data\": {\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw\",\n \"scope\": \"read:demo create:demo update:demo\",\n \"expires_in\": 90,\n \"token_type\": \"Bearer\"\n },\n \"meta\": {\n \"date_time\": \"2022-06-24T19:09:42.963Z\",\n \"name\": \"v1.tokens.authorize\",\n \"uuid\": \"ee6f9feb-dcf8-4421-a6fd-efd6beabdaa9\",\n \"start_timestamp\": 1656097782509,\n \"end_timestamp\": 1656097782963,\n \"execution_time\": 454\n }\n }\n ```\nLooking at this Response, you will see:\n * `access_token`: contains the JWT Access Token string you will use as your Bearer token.\n * `scope`: contains the scopes that this Access Token gives you permissions to access.\n * `expires_in`: contains the length of time before this Access Token will expire, in seconds.\n * `token_type`: verifies that this Access Token should be used as a Bearer token.\n\n## How to use an Access Token after one is generated?\nOnce a new Access Token is obtained, it is used in each call to a DTN API endpoint as a Bearer token in an Authorization Request Header. For example:\n ```\n Header: 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw'\n ```\n\n## Deconstructing the Access Token\nA DTN Access Token carries information within its JWT Body that is available on every API call. By deconstructing the JWT token, our Access Tokens will resemble:\n ```\n {\n \"https://auth.dtn.com/customerId\": \"1234567890Demo\",\n \"https://auth.dtn.com/productCode\": \"DemoApiP\",\n \"https://auth.dtn.com/requesterIp\": \"18.213.174.27\",\n \"https://auth.dtn.com/rps\": \"100\",\n \"https://auth.dtn.com/tier\": \"Basic\",\n \"https://auth.dtn.com/quota\": \"999999\",\n \"iss\": \"https://id.auth.dtn.com/\",\n \"sub\": \"nfyO3KiKPR8N0DKR5CL8jS9GFBCDeyFM@clients\",\n \"aud\": \"https://demo-api.auth.dtn.com/\",\n \"iat\": 1656099068,\n \"exp\": 1656099158,\n \"azp\": \"nfyO3KiKPR8N0DKR5CL8jS9GFBCDeyFM\",\n \"scope\": \"read:demo create:demo update:demo\",\n \"gty\": \"client-credentials\",\n \"permissions\": [\n \"read:demo\",\n \"create:demo\",\n \"update:demo\"\n ]\n }\n ```\n### Description of Claims\n\n | Claim | Type | Description |\n | -----------------------------------| --------------------------------------------| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dtn/refs/heads/main/openapi/dtn-possible-sigmet-fir-names-api-openapi.yml