Pause Pipeline

For a given pipeline name, this request pauses the pipeline which stops the ongoing jobs and prevents any future jobs to be scheduled for the pipeline

POST /nessie/pipeline/pause

Pause Pipeline

cURL

curl --request POST \
  --url https://{server}.mixpanel.com/api/2.0/nessie/pipeline/pause \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'name=<string>' \
  --data project_id=123

import requests

url = "https://{server}.mixpanel.com/api/2.0/nessie/pipeline/pause"

payload = {
    "name": "<string>",
    "project_id": "123"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({name: '<string>', project_id: '123'})
};

fetch('https://{server}.mixpanel.com/api/2.0/nessie/pipeline/pause', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{server}.mixpanel.com/api/2.0/nessie/pipeline/pause",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "name=%3Cstring%3E&project_id=123",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{server}.mixpanel.com/api/2.0/nessie/pipeline/pause"

	payload := strings.NewReader("name=%3Cstring%3E&project_id=123")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{server}.mixpanel.com/api/2.0/nessie/pipeline/pause")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("name=%3Cstring%3E&project_id=123")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server}.mixpanel.com/api/2.0/nessie/pipeline/pause")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "name=%3Cstring%3E&project_id=123"

response = http.request(request)
puts response.read_body

401

{
  "error": "<string>",
  "status": "error"
}

{
  "error": "<string>",
  "status": "error"
}

{
  "error": "<string>",
  "status": "error"
}

Authorizations

ServiceAccountProjectSecret

Authorization · string · header · required

Service Account

Body

application/x-www-form-urlencoded

name · string · required

The name that uniquely identifies the pipeline.

project_id · number

Your project id (must be specified when using service account based authentication)

Response

200

Success