post ephemeris - groundstation API | Specway Docs

POST

/ephemeris

http://groundstation.{region}.amazonaws.com/ephemeris

Creates an Ephemeris with the specified <code>EphemerisData</code>.

Access Token Required: API Key

Body Params

namestringrequired

A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

tagsobject

Tags assigned to an ephemeris.

enabledboolean

Whether to set the ephemeris status to <code>ENABLED</code> after validation. Setting this to false will set the ephemeris status to <code>DISABLED</code> after validation.

priorityinteger

Customer-provided priority score to establish the order in which overlapping ephemerides should be used. The default for customer-provided ephemeris priority is 1, and higher numbers take precedence. Priority must be 1 or greater

ephemerisobject

Ephemeris data.

kmsKeyArnstring

The ARN of a KMS key used to encrypt the ephemeris in Ground Station.

satelliteIdstringrequired

AWS Ground Station satellite ID for this ephemeris.

expirationTimestring

An overall expiration time for the ephemeris in UTC, after which it will become <code>EXPIRED</code>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://groundstation.{region}.amazonaws.com/ephemeris' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}