Subscriptions

Subscriptions are a declaration of interest in a particular resource, allowing a user to receive notifications when certain events occur. The events that trigger notifications are controlled by the type of subscription.

Objects

Subscription

Path	JSON Type	Format	Description
`id`	`string`	Version 4 UUID	The subscription ID
`created`	`string`	ISO 8601 timestamp	The instant the subscription was created at
`lastModified`	`string`	ISO 8601 timestamp	The instant the subscription was last modified at
`type`	`string`	Subscription Type	The type of subscription

{
  "id" : "4f0768df-39b1-4cde-905e-7e499d565ed7",
  "created" : "2026-08-07T13:29:56.567399",
  "lastModified" : "2026-08-07T13:29:56.5674",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://app.meltano.com/api/channels/f7281712-ed8e-453f-b144-1858a6557790"
    }
  }
}

Formats

Subscription Type

string

Value	Description
`ALL`	Triggers notifications for all resource events
`ALERTS`	Triggers notifications for resource alert events only
`NONE`	Does not trigger any notifications

Requests

View all subscriptions

GET /api/subscriptions

Returns all subscriptions for the authenticated user profile.

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/subscriptions' -i -X GET

import requests

url = "https://app.meltano.com:443/api/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription collection with HAL links.

{
  "_embedded" : {
    "subscriptions" : [ {
      "id" : "4f0768df-39b1-4cde-905e-7e499d565ed7",
      "created" : "2026-08-07T13:29:56.567399",
      "lastModified" : "2026-08-07T13:29:56.750285",
      "type" : "ALERTS",
      "_embedded" : {
        "channel" : {
          "name" : "matatika-limited",
          "description" : "Matatika Limited",
          "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
        },
        "subscriberProfile" : {
          "id" : "auth0|6a21dc7aa1db2e036a222942",
          "name" : "sit+prod@meltano.com",
          "handle" : "@sit+prod"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7"
        },
        "delete subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
          "type" : "PUT"
        },
        "channel" : {
          "href" : "https://app.meltano.com/api/channels/f7281712-ed8e-453f-b144-1858a6557790"
        }
      }
    }, {
      "id" : "1673d5f9-f11d-484c-b739-a80338f897fb",
      "created" : "2026-08-07T13:29:56.983128",
      "lastModified" : "2026-08-07T13:29:56.983129",
      "type" : "ALL",
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|6a21dc7aa1db2e036a222942",
          "name" : "sit+prod@meltano.com",
          "handle" : "@sit+prod"
        },
        "dataset" : {
          "id" : "c8710e86-657d-43a2-ad36-c34a4c2b2bd9",
          "published" : "2026-08-07T13:29:51.140648",
          "alias" : "simple-bar-chart",
          "workspaceId" : "0c99bad7-25e3-486b-8e19-1b5dab763f62",
          "source" : "matatika-limited",
          "title" : "How many people have visited our website?",
          "description" : "# Some Markdown\n- point 1\n- point 2\n- point 3\n",
          "questions" : "[''This is my question'', ''this is second question'']",
          "visualisation" : "{\"google-chart\": {\"chartType\": \"BarChart\",\"options\": {\"title\": \"Website visitors\"}}}",
          "query" : "SELECT to_char(date(report_date),'YYYYMM') as year_month, SUM(sessions) \n   FROM\n     \"google_analytics_website_overview\"\n   WHERE\n     \"google_analytics_website_overview\".\"report_date\" >= DATE(NOW()) - INTERVAL '365 DAY'\n   GROUP BY year_month\n   ORDER BY year_month ASC;",
          "likeCount" : 0,
          "likedByProfiles" : [ ],
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2026-08-07T13:29:51.156514",
          "score" : 1.0
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.meltano.com/api/subscriptions/1673d5f9-f11d-484c-b739-a80338f897fb"
        },
        "delete subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/1673d5f9-f11d-484c-b739-a80338f897fb",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/1673d5f9-f11d-484c-b739-a80338f897fb",
          "type" : "PUT"
        },
        "dataset" : {
          "href" : "https://app.meltano.com/api/datasets/c8710e86-657d-43a2-ad36-c34a4c2b2bd9"
        }
      }
    }, {
      "id" : "3f0eefed-8245-40cc-a69f-df304f77bd08",
      "created" : "2026-08-07T13:30:02.658829",
      "lastModified" : "2026-08-07T13:30:02.658831",
      "type" : "ALL",
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|6a21dc7aa1db2e036a222942",
          "name" : "sit+prod@meltano.com",
          "handle" : "@sit+prod"
        },
        "pipeline" : {
          "id" : "1a3918bb-ba1a-41a1-ab09-1e426a1f2f2b",
          "label" : "SIT-generated-pipeline",
          "name" : "sit-generated-pipeline",
          "lastModified" : "2026-08-07T13:29:57.453377"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.meltano.com/api/subscriptions/3f0eefed-8245-40cc-a69f-df304f77bd08"
        },
        "delete subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/3f0eefed-8245-40cc-a69f-df304f77bd08",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/3f0eefed-8245-40cc-a69f-df304f77bd08",
          "type" : "PUT"
        },
        "pipeline" : {
          "href" : "https://app.meltano.com/api/pipelines/1a3918bb-ba1a-41a1-ab09-1e426a1f2f2b"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

View all member subscriptions to a workspace

GET /api/workspaces/{workspace-id}/members/subscriptions

Returns all member subscriptions to the workspace {workspace-id}.

Prerequisites

Workspace {workspace-id} must exist

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/workspaces/0c99bad7-25e3-486b-8e19-1b5dab763f62/members/subscriptions' -i -X GET

import requests

url = "https://app.meltano.com:443/api/workspaces/0c99bad7-25e3-486b-8e19-1b5dab763f62/members/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription collection with HAL links.

{
  "_embedded" : {
    "subscriptions" : [ {
      "id" : "c8f51446-4813-4fdd-b3ed-29dc29e1d200",
      "created" : "2026-08-07T13:30:02.818171",
      "lastModified" : "2026-08-07T13:30:02.818172",
      "type" : "ALL",
      "_embedded" : {
        "subscriberWorkspace" : {
          "id" : "0c99bad7-25e3-486b-8e19-1b5dab763f62",
          "name" : "Test Workspace [2026-08-07T13:29:50.414778380]"
        },
        "workspace" : {
          "id" : "0c99bad7-25e3-486b-8e19-1b5dab763f62",
          "name" : "Test Workspace [2026-08-07T13:29:50.414778380]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.meltano.com/api/subscriptions/c8f51446-4813-4fdd-b3ed-29dc29e1d200"
        },
        "update subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/c8f51446-4813-4fdd-b3ed-29dc29e1d200",
          "type" : "PUT"
        },
        "delete subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/c8f51446-4813-4fdd-b3ed-29dc29e1d200",
          "type" : "DELETE"
        },
        "workspace" : {
          "href" : "https://app.meltano.com/api/workspaces/0c99bad7-25e3-486b-8e19-1b5dab763f62"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/workspaces/0c99bad7-25e3-486b-8e19-1b5dab763f62/members/subscriptions?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

View a subscription

GET /api/subscriptions/{subscription-id}

Returns the subscription {subscription-id}.

Prerequisites

Subscription {subscription-id} must exist

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7' -i -X GET

import requests

url = "https://app.meltano.com:443/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "4f0768df-39b1-4cde-905e-7e499d565ed7",
  "created" : "2026-08-07T13:29:56.567399",
  "lastModified" : "2026-08-07T13:29:56.5674",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://app.meltano.com/api/channels/f7281712-ed8e-453f-b144-1858a6557790"
    }
  }
}

POST /api/workspaces/{workspace-id}/subscriptions

Subscribes the authenticated user profile to the workspace {workspace-id}.

By default, the subscription is configured for all workspace events (see Subscription Type for more information).

Prerequisites

Workspace {workspace-id} must exist

Query Parameters

Parameter	Required	Format	Default Value	Description
`allMembers`	No	Boolean	`false`	Whether or not to subscribe the workspace to workspace events, in order to enable workspace-wide notifications for all members by default (applicable for the workspace owner only)

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/workspaces/0c99bad7-25e3-486b-8e19-1b5dab763f62/subscriptions?allMembers=true' -i -X POST \
    -H 'Content-Type: application/json'

import requests

url = "https://app.meltano.com:443/api/workspaces/0c99bad7-25e3-486b-8e19-1b5dab763f62/subscriptions?allMembers=true"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "c8f51446-4813-4fdd-b3ed-29dc29e1d200",
  "created" : "2026-08-07T13:30:02.818170835",
  "lastModified" : "2026-08-07T13:30:02.818172399",
  "type" : "ALL",
  "_embedded" : {
    "subscriberWorkspace" : {
      "id" : "0c99bad7-25e3-486b-8e19-1b5dab763f62",
      "name" : "Test Workspace [2026-08-07T13:29:50.414778380]"
    },
    "workspace" : {
      "id" : "0c99bad7-25e3-486b-8e19-1b5dab763f62",
      "name" : "Test Workspace [2026-08-07T13:29:50.414778380]"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/c8f51446-4813-4fdd-b3ed-29dc29e1d200"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/c8f51446-4813-4fdd-b3ed-29dc29e1d200",
      "type" : "PUT"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/c8f51446-4813-4fdd-b3ed-29dc29e1d200",
      "type" : "DELETE"
    },
    "workspace" : {
      "href" : "https://app.meltano.com/api/workspaces/0c99bad7-25e3-486b-8e19-1b5dab763f62"
    }
  }
}

POST /api/channels/{channel-id}/subscriptions

Subscribes the authenticated user profile to the channel {channel-id}.

By default, the subscription is configured for all channel events (see Subscription Type for more information).

Prerequisites

Channel {channel-id} must exist

Query Parameters

Parameter	Required	Format	Default Value	Description
`allMembers`	No	Boolean	`false`	Whether or not to subscribe the workspace to channel events, enabling notifications for all members by default (applicable for the workspace owner only)

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/channels/f7281712-ed8e-453f-b144-1858a6557790/subscriptions' -i -X POST \
    -H 'Content-Type: application/json'

import requests

url = "https://app.meltano.com:443/api/channels/f7281712-ed8e-453f-b144-1858a6557790/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "4f0768df-39b1-4cde-905e-7e499d565ed7",
  "created" : "2026-08-07T13:29:56.567398788",
  "lastModified" : "2026-08-07T13:29:56.567399893",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://app.meltano.com/api/channels/f7281712-ed8e-453f-b144-1858a6557790"
    }
  }
}

POST /api/datasets/{dataset-id}/subscriptions

Subscribes the authenticated user profile to the dataset {dataset-id}.

By default, the subscription is configured for all dataset events (see Subscription Type for more information).

Prerequisites

Dataset {dataset-id} must exist

Query Parameters

Parameter	Required	Format	Default Value	Description
`allMembers`	No	Boolean	`false`	Whether or not to subscribe the workspace to dataset events, enabling notifications for all members by default (applicable for the workspace owner only)

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/datasets/c8710e86-657d-43a2-ad36-c34a4c2b2bd9/subscriptions' -i -X POST \
    -H 'Content-Type: application/json'

import requests

url = "https://app.meltano.com:443/api/datasets/c8710e86-657d-43a2-ad36-c34a4c2b2bd9/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "1673d5f9-f11d-484c-b739-a80338f897fb",
  "created" : "2026-08-07T13:29:56.983127583",
  "lastModified" : "2026-08-07T13:29:56.983128727",
  "type" : "ALL",
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    },
    "dataset" : {
      "id" : "c8710e86-657d-43a2-ad36-c34a4c2b2bd9",
      "published" : "2026-08-07T13:29:51.140648",
      "alias" : "simple-bar-chart",
      "workspaceId" : "0c99bad7-25e3-486b-8e19-1b5dab763f62",
      "source" : "matatika-limited",
      "title" : "How many people have visited our website?",
      "description" : "# Some Markdown\n- point 1\n- point 2\n- point 3\n",
      "questions" : "[''This is my question'', ''this is second question'']",
      "visualisation" : "{\"google-chart\": {\"chartType\": \"BarChart\",\"options\": {\"title\": \"Website visitors\"}}}",
      "query" : "SELECT to_char(date(report_date),'YYYYMM') as year_month, SUM(sessions) \n   FROM\n     \"google_analytics_website_overview\"\n   WHERE\n     \"google_analytics_website_overview\".\"report_date\" >= DATE(NOW()) - INTERVAL '365 DAY'\n   GROUP BY year_month\n   ORDER BY year_month ASC;",
      "likeCount" : 0,
      "likedByProfiles" : [ ],
      "commentCount" : 0,
      "viewCount" : 0,
      "created" : "2026-08-07T13:29:51.156514",
      "score" : 1.0
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/1673d5f9-f11d-484c-b739-a80338f897fb"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/1673d5f9-f11d-484c-b739-a80338f897fb",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/1673d5f9-f11d-484c-b739-a80338f897fb",
      "type" : "PUT"
    },
    "dataset" : {
      "href" : "https://app.meltano.com/api/datasets/c8710e86-657d-43a2-ad36-c34a4c2b2bd9"
    }
  }
}

POST /api/pipelines/{pipeline-id}/subscriptions

Subscribes the authenticated user profile to the pipeline {pipeline-id}.

By default, the subscription is configured for all pipeline events (see Subscription Type for more information).

Prerequisites

Pipeline {pipeline-id} must exist

Query Parameters

Parameter	Required	Format	Default Value	Description
`allMembers`	No	Boolean	`false`	Whether or not to subscribe the workspace to pipeline events, enabling notifications for all members by default (applicable for the workspace owner only)

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/pipelines/1a3918bb-ba1a-41a1-ab09-1e426a1f2f2b/subscriptions' -i -X POST \
    -H 'Content-Type: application/json'

import requests

url = "https://app.meltano.com:443/api/pipelines/1a3918bb-ba1a-41a1-ab09-1e426a1f2f2b/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "3f0eefed-8245-40cc-a69f-df304f77bd08",
  "created" : "2026-08-07T13:30:02.658829258",
  "lastModified" : "2026-08-07T13:30:02.658830528",
  "type" : "ALL",
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    },
    "pipeline" : {
      "id" : "1a3918bb-ba1a-41a1-ab09-1e426a1f2f2b",
      "label" : "SIT-generated-pipeline",
      "name" : "sit-generated-pipeline",
      "lastModified" : "2026-08-07T13:29:57.453377"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/3f0eefed-8245-40cc-a69f-df304f77bd08"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/3f0eefed-8245-40cc-a69f-df304f77bd08",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/3f0eefed-8245-40cc-a69f-df304f77bd08",
      "type" : "PUT"
    },
    "pipeline" : {
      "href" : "https://app.meltano.com/api/pipelines/1a3918bb-ba1a-41a1-ab09-1e426a1f2f2b"
    }
  }
}

Update a subscription

PUT /api/subscriptions/{subscription-id}

Updates the subscription {subscription-id}.

Prerequisites

Subscription {subscription-id} must exist

Body

Path	JSON Type	Format	Description
`type`	`string`	Subscription Type	The type of subscription

{
  "type" : "ALERTS"
}

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "type" : "ALERTS"
}'

import requests

url = "https://app.meltano.com:443/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7"

data = {
  "type" : "ALERTS"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "4f0768df-39b1-4cde-905e-7e499d565ed7",
  "created" : "2026-08-07T13:29:56.567399",
  "lastModified" : "2026-08-07T13:29:56.750285214",
  "type" : "ALERTS",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://app.meltano.com/api/channels/f7281712-ed8e-453f-b144-1858a6557790"
    }
  }
}

Remove a subscription

DELETE /api/subscriptions/{subscription-id}

Removes the subscription {subscription-id}.

Prerequisites

Subscription {subscription-id} must exist

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7' -i -X DELETE

import requests

url = "https://app.meltano.com:443/api/subscriptions/4f0768df-39b1-4cde-905e-7e499d565ed7"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.

Objects​

Subscription​

Formats​

Subscription Type​

Requests​

View all subscriptions​

Examples

Response​

View all member subscriptions to a workspace​

Prerequisites​

Examples

Response​

View a subscription​

Prerequisites​

Examples

Response​

Subscribe to a workspace​

Prerequisites​

Query Parameters​

Examples

Response​

Subscribe to a channel​

Prerequisites​

Query Parameters​

Examples

Response​

Subscribe to a dataset​

Prerequisites​

Query Parameters​

Examples

Response​

Subscribe to a pipeline​

Prerequisites​

Query Parameters​

Examples

Response​

Update a subscription​

Prerequisites​

Body​

Examples

Response​

Remove a subscription​

Prerequisites​

Examples

Response​

Objects

Subscription

Formats

Subscription Type

Requests

View all subscriptions

Response

View all member subscriptions to a workspace

Prerequisites

Response

View a subscription

Prerequisites

Response

Subscribe to a workspace

Prerequisites

Query Parameters

Response

Subscribe to a channel

Prerequisites

Query Parameters

Response

Subscribe to a dataset

Prerequisites

Query Parameters

Response

Subscribe to a pipeline

Prerequisites

Query Parameters

Response

Update a subscription

Prerequisites

Body

Response

Remove a subscription

Prerequisites

Response