Destinations API Reference

• getList all destinations
• postCreate a new destination
• getGet the OpenAPI spec
• getGet a destination
• patchUpdate a destination

API docs by Redocly

Destinations API (v1.0.0)

Download OpenAPI specification:Download

The Destinations API provides a way to manage cloud storage destinations.

List all destinations

Authorizations:

JWTBasicAuth

query Parameters

archived	boolean Filter destinations by archived status.
is_owner	boolean Filter destinations owned by requester.
can_write	boolean Filter destinations where the requester has write permissions.
sort_by	string Sort destinations by one or more fields. Separate multiple fields with commas. Add ' ASC' or ' DESC' to specify direction (defaults to ASC). Default sort is created DESC. Supported fields: created, name, type, updated Examples: name, name DESC, name,created DESC

Responses

https://api.planet.com/destinations/v1

Response samples

• 200
• 401
• 500
• default

Content type

application/json

{

• "_links": {

  • "_self": "string"

  },
• "destinations": [

  • {

    • "_links": {

      • "_self": "string"

      },
    • "archived": "2019-08-24T14:15:22Z",
    • "created": "2019-08-24T14:15:22Z",
    • "id": "string",
    • "name": "string",
    • "ownership": {

      • "is_owner": true,
      • "owner_id": 0

      },
    • "parameters": {

      • "bucket": "string",
      • "credentials": "string"

      },
    • "permissions": {

      • "can_write": true

      },
    • "pl:ref": "string",
    • "type": "google_cloud_storage",
    • "updated": "2019-08-24T14:15:22Z"

    }

  ]

}

Create a new destination

Authorizations:

JWTBasicAuth

Request Body schema: application/json

required

name	string [ 3 .. 63 ] characters A name given to this Destination.
required	GoogleCloudStorageParams (object) or AmazonS3Params (object) or AzureCloudStorageParams (object) or OracleCloudStorageParams (object) or S3CompatibleParams (object) (DestinationParameters) Parameters for the given Destination type.
type required	string (DestinationType) Enum: "google_cloud_storage" "amazon_s3" "azure_blob_storage" "oracle_cloud_storage" "s3_compatible" The type of Destination.

Responses

https://api.planet.com/destinations/v1

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "parameters": {

  • "bucket": "string",
  • "credentials": "string"

  },
• "type": "google_cloud_storage"

}

Response samples

• 201
• 400
• 401
• 500
• default

Content type

application/json

{

• "_links": {

  • "_self": "string"

  },
• "archived": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "id": "string",
• "name": "string",
• "ownership": {

  • "is_owner": true,
  • "owner_id": 0

  },
• "parameters": {

  • "bucket": "string",
  • "credentials": "string"

  },
• "permissions": {

  • "can_write": true

  },
• "pl:ref": "string",
• "type": "google_cloud_storage",
• "updated": "2019-08-24T14:15:22Z"

}

Get the OpenAPI spec

Authorizations:

JWTBasicAuth

Responses

https://api.planet.com/destinations/v1/spec

Response samples

• 200
• 500
• default

Content type

application/json

{ }

Get a destination

Authorizations:

JWTBasicAuth

path Parameters

destinationID required

string

Responses

https://api.planet.com/destinations/v1/{destinationID}

Response samples

• 200
• 401
• 404
• 500
• default

Content type

application/json

{

• "_links": {

  • "_self": "string"

  },
• "archived": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "id": "string",
• "name": "string",
• "ownership": {

  • "is_owner": true,
  • "owner_id": 0

  },
• "parameters": {

  • "bucket": "string",
  • "credentials": "string"

  },
• "permissions": {

  • "can_write": true

  },
• "pl:ref": "string",
• "type": "google_cloud_storage",
• "updated": "2019-08-24T14:15:22Z"

}

Update a destination

Authorizations:

JWTBasicAuth

path Parameters

destinationID required

string

Request Body schema: application/json

required

Any of

archive	boolean True to archive the destination, false to unarchive.
name	string [ 3 .. 63 ] characters A string to uniquely identify a Destination.
required	GoogleCloudStoragePatchParams (object) or AmazonS3PatchParams (object) or AzureCloudStoragePatchParams (object) or OracleCloudStoragePatchParams (object) or S3CompatiblePatchParams (object) (DestinationPatchParameters) Patch parameters for the given Destination type.

Responses

https://api.planet.com/destinations/v1/{destinationID}

Request samples

• Payload

Content type

application/json

{

• "archive": true,
• "name": "string",
• "parameters": {

  • "credentials": "string"

  }

}

Response samples

• 200
• 400
• 401
• 404
• 500
• default

Content type

application/json

{

• "_links": {

  • "_self": "string"

  },
• "archived": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "id": "string",
• "name": "string",
• "ownership": {

  • "is_owner": true,
  • "owner_id": 0

  },
• "parameters": {

  • "bucket": "string",
  • "credentials": "string"

  },
• "permissions": {

  • "can_write": true

  },
• "pl:ref": "string",
• "type": "google_cloud_storage",
• "updated": "2019-08-24T14:15:22Z"

}