THIS ENDPOINT IS STILL UNDER DEVELOPMENT.
Import Endpoint
Import functionality for stages, pipelines, endpoints and configuration files.
Import .gea file
This endpoint allows you to import files exported from another GAIA API instance.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| file | file | The .gea file to import, can be a stage, pipeline, endpoint or all files. |
IMPORTANT
If you use this endpoint, after importing the .gea file, the API will RESTART in order to load the new files that were imported, so, if you have requests pending or it is being used at the moment, it will fail those processes and restart the server from zero.
Example
POST /es/api/v1/importer
Response
Successful Response [200]
Import successful
Validation Error [422]
{
"detail": [
{
"loc": ["body", "file"],
"msg": "Field required",
"type": "value_error.missing"
}
]
}
Export Endpoint
Export functionality for stages, pipelines, endpoints and configuration files.
We create .gea files inside the "exports" folder inside the root of the GAIA API instance.
These .gea files may or may not have nested .gea files representing nested stages or pipelines related between each other.
Export All
This endpoint allows you to export all stages, pipelines, endpoints enabled and configuration files into a .gea file that can be imported into another instance of GAIA API.
Parameters
This endpoint does not require parameters.
Example
GET /es/api/v1/export/all
Response
Successful Response [200]
Export successful
Export All (Stages)
This endpoint allows you to export all the stages into a .gea file.
Parameters
This endpoint does not require parameters.
Example
GET /es/api/v1/export/stage/all
Response
Successful Response [200]
Export successful
Export Stage
This endpoint allows you to export a specific stage into a .gea file by its name.
Parameters
| Parameter | Type | Description |
|---|---|---|
| stage_name | string | The name of the stage to export. |
Example
GET /es/api/v1/export/stage/{stage_name}
Response
Successful Response [200]
Export successful
Export All (Pipelines)
This endpoint allows you to export all the pipelines into a .gea file with its own stages (if the pipeline has stages configured).
Parameters
This endpoint does not require parameters.
Example
GET /es/api/v1/export/pipeline/all
Response
Successful Response [200]
Export successful
Export Pipeline
This endpoint allows you to export a specific pipeline into a .gea file by its name alongside its stages configured (if it has stages).
Parameters
| Parameter | Type | Description |
|---|---|---|
| pipeline_name | string | The name of the pipeline to export. |
Example
GET /es/api/v1/export/pipeline/{pipeline_name}
Response
Successful Response [200]
Export successful
Export All (Endpoints)
This endpoint allows you to export all the endpoints into a .gea file with its own pipelines and stages (if the endpoint has a pipeline wrapper configured).
Parameters
This endpoint does not require parameters.
Example
GET /es/api/v1/export/endpoint/all
Response
Successful Response [200]
Export successful
Export Endpoint
This endpoint allows you to export a specific endpoint into a .gea file by its name alongside its pipeline/stages configured (if it has a pipeline wrapper).
Parameters
| Parameter | Type | Description |
|---|---|---|
| endpoint_name | string | The name of the endpoint to export. |
Example
GET /es/api/v1/export/endpoint/{endpoint_name}
Response
Successful Response [200]
Export successful
Overview
Content Tools