amp destinations
amp destinations manages destinations in a project. Read commands require destinations:read. Create, update, test, and Snowflake key generation require destinations:write.
List partner types first with amp destination-types so you pass a valid --partner and config.
amp destinations list
Lists destinations in a project. Use --q to search, --partner to filter by partner, --enabled to filter by state, and --kind to filter by connector kind.
amp destinations list --project <project_id> --limit 5
amp destinations list --project <project_id> --partner <partner> --enabled true
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--cursor | string | No | Opaque cursor from pagination.next_cursor on the previous response. Numeric offsets are capped by the underlying search index (10,000 results per query). Well-formed pagination stops before that window; requests whose cursor would exceed it return 400 pagination_not_supported. Alias: --next-cursor. |
--limit | integer | No | Number of items to return. Defaults to 50, max 200. |
--q | string | No | Full-text search query. Alias: --query. |
--partner | string | No | Filter by destination partner key. |
--enabled | boolean | No | Filter by enabled/active flag. |
--kind | string | No | Filter by a single connector kind; matches destinations whose kind array contains this value. |
Requires the destinations:read scope.
amp destinations get
Returns one destination.
amp destinations get --project <project_id> --id <destination_id>
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--id | string | Yes | Destination id. |
Requires the destinations:read scope.
amp destinations create
Creates a destination. Pass --partner and --display-name; Amplitude assigns the destination id. Repeating create with the same display name creates another destination. Pass --dry-run to return a plan envelope without creating the destination.
The API treats secret and OAuth config values as write-only. Pass nested config, kind, event_filter, and property_mappings with --body-json when flags aren't enough.
You can omit kind when the partner has one capability. For a multi-capability partner, pass kind so the request isn't ambiguous. The three families are mutually exclusive: a subset of event and identify, or cohort, or warehouse_export. Don't combine families.
amp destinations create --project <project_id> --partner <partner> --display-name "My destination"
amp destinations create --project <project_id> --partner <partner> --display-name "My destination" --dry-run
amp destinations create --project <project_id> --partner <partner> --display-name "My destination" \
--body-json '{"config":{},"enabled":true}'
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--dry-run | boolean | No | Validate request without performing mutation. |
--partner | string | Yes | |
--display-name | string | Yes | |
--kind | array | No | Optional connector kinds. When omitted, the kind is inferred from the partner's capabilities; a multi-capability partner with no kind is rejected as ambiguous. When provided it is authoritative and validated against the partner. The three families are mutually exclusive: a subset of [event, identify], or [cohort], or [warehouse_export] — never combined. JSON array, or a comma-separated list for strings. |
--config | object | No | |
--enabled | boolean | No | |
--event-filter | object | No | |
--property-mappings | object | No | |
--send-events | boolean | No | |
--send-users | boolean | No |
Requires the destinations:write scope.
amp destinations update
Updates a destination. Use --project and --id to identify it, then pass the fields to change, or pass --body-json to merge additional fields. Pass --if-match with the destination's current version for a conditional update. --dry-run returns a plan envelope without mutating.
amp destinations update --project <project_id> --id <destination_id> --display-name "Updated name"
amp destinations update --project <project_id> --id <destination_id> --dry-run --body-json '{"enabled":false}'
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--id | string | Yes | Destination id. |
--dry-run | boolean | No | Validate request without performing mutation. |
--if-match | integer | No | Optimistic concurrency token. Must equal the resource version for the write to proceed; otherwise the API returns 412. |
--display-name | string | No | |
--kind | array | No | JSON array, or a comma-separated list for strings. |
--config | object | No | |
--enabled | boolean | No | |
--event-filter | object | No | |
--property-mappings | object | No | |
--send-events | boolean | No | |
--send-users | boolean | No |
Requires the destinations:write scope.
amp destinations test-destination
Tests an event streaming destination connection.
amp destinations test-destination --project <project_id> --id <destination_id>
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--id | string | Yes | Destination id. |
--test-event-payload | string | No | JSON event to send to the destination. Omit the field to use the partner's example event. An empty string is rejected. |
Requires the destinations:write scope.
amp destinations generate-snowflake-rsa-key
Generates a Snowflake-compatible RSA key pair. Amplitude stores the private key in an ephemeral server-side cache. The response includes the public key and an ephemeral ID. Paste the public key into Snowflake with ALTER USER <user> SET RSA_PUBLIC_KEY = '...'. Then pass snowflake_private_key_ephemeral_id in the destination config on a later amp destinations create for a Snowflake direct-load destination.
amp destinations generate-snowflake-rsa-key --project <project_id> --idempotency-key <unique_key>
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
Requires the destinations:write scope.
Was this helpful?
For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.