Skip to main content
GET
/
environment
/
{environmentId}
/
services
List Services By EnvironmentId
curl --request GET \
  --url https://api.qovery.com/environment/{environmentId}/services \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "storage": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "FAST_SSD",
          "size": 16,
          "mount_point": "/mnt/images"
        }
      ],
      "environment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "git_repository": {
        "has_access": "<any>",
        "provider": "<any>",
        "owner": "<any>",
        "url": "<any>",
        "name": "<any>",
        "branch": "<any>",
        "root_path": "<any>",
        "deployed_commit_id": "<any>",
        "deployed_commit_date": "<any>",
        "deployed_commit_contributor": "<any>",
        "deployed_commit_tag": "<any>",
        "git_token_id": "<any>",
        "git_token_name": "<any>"
      },
      "maximum_cpu": 16000,
      "maximum_memory": 16384,
      "maximun_gpu": 0,
      "name": "<string>",
      "description": "<string>",
      "build_mode": "DOCKER",
      "dockerfile_path": "<string>",
      "cpu": 1250,
      "memory": 1024,
      "gpu": 0,
      "min_running_instances": 1,
      "max_running_instances": 1,
      "healthchecks": {
        "readiness_probe": {
          "type": "<any>",
          "initial_delay_seconds": "<any>",
          "period_seconds": "<any>",
          "timeout_seconds": "<any>",
          "success_threshold": "<any>",
          "failure_threshold": "<any>"
        },
        "liveness_probe": {
          "type": "<any>",
          "initial_delay_seconds": "<any>",
          "period_seconds": "<any>",
          "timeout_seconds": "<any>",
          "success_threshold": "<any>",
          "failure_threshold": "<any>"
        }
      },
      "auto_preview": true,
      "ports": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "internal_port": 8080,
          "external_port": 8080,
          "publicly_accessible": true,
          "is_default": true,
          "protocol": "HTTP",
          "public_path": "<string>",
          "public_path_rewrite": "<string>"
        }
      ],
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>",
      "auto_deploy": true,
      "annotations_groups": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "annotations": [
            {}
          ],
          "scopes": [
            "DEPLOYMENTS"
          ]
        }
      ],
      "labels_groups": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "labels": [
            {}
          ]
        }
      ],
      "icon_uri": "<string>",
      "service_type": "APPLICATION",
      "docker_target_build_stage": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Path Parameters

environmentId
string
required

Response

200 - application/json

Service List

results
object[]
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 6
  • Option 7