Get list of pipelines by Company ID
SecuritybearerAuth
Request
Responses
200
Response object of pipelines requests
401
No or invalid API key provided to the request
404
Could not find the company or the user does not have permissions to retrieve data
500
Error occurred while retrieving pipelines
get/pipelines
Request samples
- curl
- Node.js
- Browser JavaScript
- PHP
curl -i -X GET \ 'https://api.kinsta.com/v2/pipelines?company=54fb80af-576c-4fdc-ba4f-b596c83f15a1&limit=10&offset=3' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
- 200
- 401
- 404
- 500
application/json
{- "company": {
- "pipelines": {
- "items": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "display_name": "first pipeline",
- "stages": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "display_name": "Staging",
- "type": "standard"
}
]
}
]
}
}
}Create preview app
SecuritybearerAuth
Request
Responses
200
Preview app created successfully
401
No or invalid API key provided to the request
500
Error occurred while creating a preview app
post/pipelines/{id}/create-preview-app
Request samples
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
application/json
{- "branch": "main",
- "pull_request_number": 14
}Response samples
- 200
- 401
- 500
application/json
{- "app": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "name": "test-app",
- "displayName": "Test App"
}
}