2020-05-29 18:08:26 +00:00
---
stage: Verify
group: Continuous Integration
2020-11-26 06:09:20 +00:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-05-29 18:08:26 +00:00
type: reference, howto
---
2019-12-14 09:07:51 +00:00
# External Pipeline Validation
2021-04-05 18:09:15 +00:00
You can use an external service to validate a pipeline before it's created.
2019-12-14 09:07:51 +00:00
2020-12-04 21:09:29 +00:00
WARNING:
2019-12-14 09:07:51 +00:00
This is an experimental feature and subject to change without notice.
## Usage
2020-11-18 18:09:08 +00:00
GitLab sends a POST request to the external service URL with the pipeline
data as payload. GitLab then invalidates the pipeline based on the response
code. If there's an error or the request times out, the pipeline is not
2019-12-14 09:07:51 +00:00
invalidated.
2021-04-05 18:09:15 +00:00
Response codes:
2019-12-14 09:07:51 +00:00
2021-04-05 18:09:15 +00:00
- `200` : Accepted
2021-05-06 21:10:07 +00:00
- `4XX` : Rejected
2021-04-05 18:09:15 +00:00
- All other codes: accepted and logged
2019-12-14 09:07:51 +00:00
2021-05-05 21:09:59 +00:00
### Service Result
2021-05-06 21:10:07 +00:00
Pipelines rejected by the external validation service aren't created or visible in pipeline lists, in either the GitLab user interface or API. Creating an unaccepted pipeline when using the GitLab user interface displays an error message that states: `Pipeline cannot be run. External validation failed`
2021-05-05 21:09:59 +00:00
2019-12-14 09:07:51 +00:00
## Configuration
2021-04-05 18:09:15 +00:00
To configure external pipeline validation, add the
[`EXTERNAL_VALIDATION_SERVICE_URL` environment variable ](environment_variables.md )
and set it to the external service URL.
2021-03-30 09:10:51 +00:00
By default, requests to the external service time out after five seconds. To override
the default, set the `EXTERNAL_VALIDATION_SERVICE_TIMEOUT` environment variable to the
required number of seconds.
2019-12-14 09:07:51 +00:00
## Payload Schema
```json
{
"type": "object",
"required" : [
"project",
"user",
"pipeline",
2021-03-23 18:09:05 +00:00
"builds",
"namespace"
2019-12-14 09:07:51 +00:00
],
"properties" : {
"project": {
"type": "object",
"required": [
"id",
2021-03-23 18:09:05 +00:00
"path",
"created_at"
2019-12-14 09:07:51 +00:00
],
"properties": {
"id": { "type": "integer" },
2021-03-23 18:09:05 +00:00
"path": { "type": "string" },
"created_at": { "type": ["string", "null"], "format": "date-time" }
2019-12-14 09:07:51 +00:00
}
},
"user": {
"type": "object",
"required": [
"id",
"username",
2021-03-23 18:09:05 +00:00
"email",
"created_at"
2019-12-14 09:07:51 +00:00
],
"properties": {
"id": { "type": "integer" },
"username": { "type": "string" },
2021-03-23 18:09:05 +00:00
"email": { "type": "string" },
"created_at": { "type": ["string", "null"], "format": "date-time" }
2019-12-14 09:07:51 +00:00
}
},
"pipeline": {
"type": "object",
"required": [
"sha",
"ref",
"type"
],
"properties": {
"sha": { "type": "string" },
"ref": { "type": "string" },
"type": { "type": "string" }
}
},
"builds": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"stage",
"image",
"services",
"script"
],
"properties": {
"name": { "type": "string" },
"stage": { "type": "string" },
"image": { "type": ["string", "null"] },
"services": {
"type": ["array", "null"],
"items": { "type": "string" }
},
"script": {
"type": "array",
"items": { "type": "string" }
}
}
}
2021-03-23 18:09:05 +00:00
},
"namespace": {
"type": "object",
"required": [
"plan",
"trial"
],
"properties": {
"plan": { "type": "string" },
"trial": { "type": "boolean" }
}
2019-12-14 09:07:51 +00:00
}
2021-03-23 18:09:05 +00:00
}
2019-12-14 09:07:51 +00:00
}
```
2021-04-05 18:09:15 +00:00
The `namespace` field is only available in [GitLab Premium ](https://about.gitlab.com/pricing/ )
and higher.