You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

THIS PAGE 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

ParameterTypeDescription
filefileThe .gea file to import, can be a stage, pipeline, endpoint or all files.



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

ParameterTypeDescription
namestring

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


Example

GET /es/api/v1/export/stage/all

Response

Successful Response [200]

Export successful
  • No labels