Stop a pipeline

POST 
https://api.vectorize.io/v1/org/:organization/pipelines/:pipeline/stop

Stop a pipeline

Request

Path Parameters

organization stringrequired
pipeline stringrequired

Responses

200

Pipeline stopped successfully

application/json

Schema

Schema

messagestringrequired

Example (auto)

{
  "message": "string"
}

400

Invalid request

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

401

Unauthorized

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

403

Forbidden

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

404

Not found

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

500

Internal server error

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWT

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.vectorize.io/v1/org/:organization/pipelines/:pipeline/stop");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.vectorize.io/v1

Auth

Bearer Token

Parameters

organization — pathrequired

pipeline — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!