AirHub API

Create Ephemeral Operations

Sandbox

POST

/v1/operations/ephemeral

Ephemeral Operations

Last modified:2024-10-17 12:02:49

Scope: operation:create

This method will create a new Ephemeral Operation.

Request

Body Params application/json

name

string

required

The name for this operation

flightType

enum<string>

required

Allowed values:

FLIGHT_TYPE_UNSPECIFIEDFLIGHT_TYPE_RECREATIONALFLIGHT_TYPE_COMMERCIAL

Default:

FLIGHT_TYPE_UNSPECIFIED

maxAltitude

integer <int32>

required

The max altitude for the flight volume. Must be greater than or equal to min altitude.

fixedAltitude

boolean

optional

Whether this operation will fly at a fixed altitude throughout its entirety

callbackUrl

string

optional

URL that will recieve notifications when this operation has a status change

timezoneName

string

required

The timezone in which this operation will take place in IANA Time Zone format. Used only as a display helper in client applications.

startTime

string <date-time>

required

The start time for this operation in RFC 3339 UTC format

duration

integer <int32>

required

Duration of this operation in minutes

boundary

object

required

The geographic boundary for this operation represented in GeoJSON Polygon format

Example

{
  "boundary": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -78.55714924875102,
          38.15773996731016
        ],
        [
          -78.55714924875102,
          38.121934862230276
        ],
        [
          -78.51075174761395,
          38.121934862230276
        ],
        [
          -78.51075174761395,
          38.15773996731016
        ],
        [
          -78.55714924875102,
          38.15773996731016
        ]
      ]
    ]
  },
  "name": "Operation 97",
  "flightType": "FLIGHT_TYPE_RECREATIONAL",
  "maxAltitude": 200,
  "fixedAltitude": false,
  "callbackUrl": "https://myurl.com/operation/1234",
  "timezoneName": "America/New_York",
  "startTime": "2024-08-23T20:25:00.000Z",
  "duration": 55
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://airhub-api-sandbox.airspacelink.com/v1/operations/ephemeral' \
--header 'Content-Type: application/json' \
--data-raw '{
    "boundary": {
        "type": "Polygon",
        "coordinates": [
            [
                [
                    -78.55714924875102,
                    38.15773996731016
                ],
                [
                    -78.55714924875102,
                    38.121934862230276
                ],
                [
                    -78.51075174761395,
                    38.121934862230276
                ],
                [
                    -78.51075174761395,
                    38.15773996731016
                ],
                [
                    -78.55714924875102,
                    38.15773996731016
                ]
            ]
        ]
    },
    "name": "Operation 97",
    "flightType": "FLIGHT_TYPE_RECREATIONAL",
    "maxAltitude": 200,
    "fixedAltitude": false,
    "callbackUrl": "https://myurl.com/operation/1234",
    "timezoneName": "America/New_York",
    "startTime": "2024-08-23T20:25:00.000Z",
    "duration": 55
}'

Responses

🟢200OK

application/json

A successful response.

Body

url

string

required

URL that can be used to claim the Ephemeral Operation at a later time

Example

{
  "url": "https://portal.airspacelink.com/plan/operations/81042622-4f02-4e85-a896-172edd5381b6/claim"
}

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Modified at 2024-10-17 12:02:49

Operation v2

Get Hazard