--- title: "Get application by ID" method: GET path: "/application/{applicationId}" tags: ["Application Main Calls"] --- # Get application by ID `GET /application/{applicationId}` ## Request - Base URL: `https://api.qovery.com` - URL: `https://api.qovery.com/application/{applicationId}` - Auth: one of: - API key in header `Authorization` - HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `applicationId` string, uuid, required ## Response `200` Get application by ID - Application - `id` string, uuid, required - `created_at` string, date-time, required - `updated_at` string, date-time - `storage` object[] - `id` string, uuid, required - `type` 'FAST_SSD', required - `size` integer, required: unit is GB - `mount_point` string, required - `environment` ReferenceObject, required - `id` string, uuid, required - `git_repository` ApplicationGitRepository - `has_access` boolean - `provider` 'BITBUCKET' | 'GITHUB' | 'GITLAB', required - `owner` string, required - `url` string, uri, required - `name` string, required: repository name - `branch` string - `root_path` string - `deployed_commit_id` string: Git commit ID corresponding to the deployed version of the app - `deployed_commit_date` string, date-time: Git commit date corresponding to the deployed version of the app - `deployed_commit_contributor` string: Git commit user corresponding to the deployed version of the app - `deployed_commit_tag` string - `git_token_id` string, nullable - `git_token_name` string, nullable - `maximum_cpu` integer: Maximum cpu that can be allocated to the application based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu - `maximum_memory` integer: Maximum memory that can be allocated to the application based on organization cluster configuration. unit is MB. 1024 MB = 1GB - `maximun_gpu` integer - `name` string, required: name is case insensitive - `description` string: give a description to this application - `build_mode` 'DOCKER': `DOCKER` requires `dockerfile_path` - `dockerfile_path` string, nullable: The path of the associated Dockerfile. Only if you are using build_mode = DOCKER - `cpu` integer: unit is millicores (m). 1000m = 1 cpu - `memory` integer: unit is MB. 1024 MB = 1GB - `gpu` integer - `min_running_instances` integer: Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running. - `max_running_instances` integer: Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit. - `healthchecks` Healthcheck, required - `readiness_probe` Probe, nullable - `type` object - `tcp` object, nullable - `port` integer - `host` string, nullable - `http` object, nullable - `path` string - `scheme` string - `port` integer - `exec` object, nullable - `command` string[] - `grpc` object, nullable - `service` string, nullable - `port` integer - `initial_delay_seconds` integer - `period_seconds` integer - `timeout_seconds` integer - `success_threshold` integer - `failure_threshold` integer - `liveness_probe` Probe, nullable - `type` object - `tcp` object, nullable - `port` integer - `host` string, nullable - `http` object, nullable - `path` string - `scheme` string - `port` integer - `exec` object, nullable - `command` string[] - `grpc` object, nullable - `service` string, nullable - `port` integer - `initial_delay_seconds` integer - `period_seconds` integer - `timeout_seconds` integer - `success_threshold` integer - `failure_threshold` integer - `auto_preview` boolean: Specify if the environment preview option is activated or not for this application. If activated, a preview environment will be automatically cloned at each pull request. If not specified, it takes the value of the `auto_preview` property from the associated environment. - `ports` ServicePort[] - `id` string, uuid, required - `name` string - `internal_port` integer, required: The listening port of your service. - `external_port` integer: The exposed port for your service. This is optional. If not set a default port will be used. - `publicly_accessible` boolean, required: Expose the port to the world - `is_default` boolean: is the default port to use for domain - `protocol` 'HTTP' | 'GRPC' | 'TCP' | 'UDP', required - `public_path` string: Indicate the path or regex that must match for traffic to be accepted on your service i.e: /api/ will only accept http calls that start with /api/ Only valid for publicly_accessible HTTP or GRPC ports. - `public_path_rewrite` string: Indicate the new path that will be used to reach your service after replacement i.e: public_path -> /(.*) public_path_rewrite -> /api/$1 will append /api/ on all externaly requested url when reaching the service external/use url -> example.com/foobar -> url seen by the service -> example.com/api/foobar Only valid for publicly_accessible HTTP or GRPC ports. - `arguments` string[] - `entrypoint` string: optional entrypoint when launching container - `auto_deploy` boolean: Specify if the application will be automatically updated after receiving a new commit. - `annotations_groups` OrganizationAnnotationsGroupResponse[] - `id` string, uuid, required - `created_at` string, date-time, required - `updated_at` string, date-time - `name` string, required - `annotations` Annotation[], required - `key` string, required - `value` string, required - `scopes` OrganizationAnnotationsGroupScopeEnum[], required - `labels_groups` OrganizationLabelsGroupResponse[] - `id` string, uuid, required - `created_at` string, date-time, required - `updated_at` string, date-time - `name` string, required - `labels` Label[], required - `key` string, required - `value` string, required - `propagate_to_cloud_provider` boolean, required - `icon_uri` string, uri, required: Icon URI representing the application. - `service_type` 'APPLICATION' | 'DATABASE' | 'CONTAINER' | 'JOB' | 'HELM' | 'TERRAFORM', required: type of the service (application, database, job, ...) - `docker_target_build_stage` string, nullable: The target build stage in the Dockerfile to build ## Other responses - `401`: Access token is missing or invalid - `403`: Access forbidden - `404`: Resource not found --- [API](https://skmtc.dev/qovery/apis/qovery-api.md) - [All operations](https://skmtc.dev/qovery/apis/qovery-api/llms.txt) - [OpenAPI document](https://skmtc.dev/qovery/apis/qovery-api/revisions/93c4960a44ba?raw)