--- title: "find app by handle" method: GET path: "/find/app" tags: ["Apps"] --- # find app by handle `GET /find/app` ## Request - Base URL: `https://api.aptible.com` - URL: `https://api.aptible.com/find/app` - Auth: API key in header `Authorization` Returns the app matching the specified handle. ## Query parameters - `handle` string, required - `environment` string - `no_embed` boolean ## Headers - `Prefer` 'no_sensitive_extras=true' ## Response `200` successful - App - `id` integer, required - `handle` string, required - `git_repo` string, required - `_type` string, required - `created_at` string, dateTime, required - `updated_at` string, dateTime, required - `status` string, required - `deployment_method` string, required - `_embedded` AppEmbedded, required - `services` Service[] - `id` integer, required - `_type` string, required - `handle` string, required - `docker_repo` string, required - `docker_ref` string, required - `process_type` string, required - `command` string, required - `container_count` integer, required - `created_at` string, dateTime, required - `updated_at` string, dateTime, required - `container_memory_limit_mb` integer, required - `instance_class` string, required - `force_zero_downtime` boolean, required - `naive_health_check` boolean, required - `restart_free_scaling` boolean, required - `stop_timeout` integer, required - `_links` ServiceLinks - `account` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `current_release` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `app` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `database` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `operations` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `releases` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `vhosts` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `settings` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `current_setting` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `self` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `last_operation` Operation - `id` integer, required - `_type` string, required - `type` string, required - `status` string, required - `cancelled` boolean, required - `aborted` boolean, required - `git_ref` string, required - `docker_ref` string, required - `deploy_image_id` integer - `env` object - `container_size` integer, required - `container_count` integer, required - `disk_size` integer, required - `command` string, required - `handle` string, required - `created_at` string, dateTime, required - `updated_at` string, dateTime, required - `certificate` string, required - `private_key` string - `user_name` string, required - `user_email` string, required - `destination_region` string, required - `interactive` boolean, required - `instance_profile` string, required - `mount_point` string, required - `daily` integer, required - `monthly` integer, required - `yearly` integer, required - `pitr_days` integer, required - `make_copy` boolean, required - `keep_final` boolean, required - `enable_backups` boolean, required - `enable_pitr` boolean, required - `settings` object, required - `sensitive_settings` object - `_links` OperationLinks - `user` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `resource` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `account` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `destination_account` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `ssh_portal_connections` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `ephemeral_sessions` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `code_scan_result` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `deploy_image` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `service` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `self` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `last_deploy_operation` Operation - `id` integer, required - `_type` string, required - `type` string, required - `status` string, required - `cancelled` boolean, required - `aborted` boolean, required - `git_ref` string, required - `docker_ref` string, required - `deploy_image_id` integer - `env` object - `container_size` integer, required - `container_count` integer, required - `disk_size` integer, required - `command` string, required - `handle` string, required - `created_at` string, dateTime, required - `updated_at` string, dateTime, required - `certificate` string, required - `private_key` string - `user_name` string, required - `user_email` string, required - `destination_region` string, required - `interactive` boolean, required - `instance_profile` string, required - `mount_point` string, required - `daily` integer, required - `monthly` integer, required - `yearly` integer, required - `pitr_days` integer, required - `make_copy` boolean, required - `keep_final` boolean, required - `enable_backups` boolean, required - `enable_pitr` boolean, required - `settings` object, required - `sensitive_settings` object - `_links` OperationLinks - `user` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `resource` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `account` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `destination_account` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `ssh_portal_connections` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `ephemeral_sessions` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `code_scan_result` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `deploy_image` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `service` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `self` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `current_image` Image - `id` integer, required - `git_repo` string, required - `git_ref` string, required - `docker_repo` string, required - `docker_ref` string, required - `dualstack_hint` integer, required - `platform` string, required - `release` string, required - `scan` string, required - `exposed_ports` integer[], required - `_type` string, required - `created_at` string, dateTime, required - `updated_at` string, dateTime, required - `_links` ImageLinks - `app` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `operations` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `self` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `_links` AppLinks - `account` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `current_configuration` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `current_image` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `operations` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `images` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `configurations` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `services` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `vhosts` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `ephemeral_sessions` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `service_definitions` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `prerelease_commands` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `code_scan_results` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `last_code_scan_result` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `deployments` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `current_deployment` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `settings` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `current_setting` ListAccountsForStack200ResponseLinksStack - `href` string, uri - `self` ListAccountsForStack200ResponseLinksStack - `href` string, uri ## Other responses - `default`: Error response. Often a 4xx or 5xx status code ## Changes - **2026-10-20** `ba72edfe0324`: 4 info - added the optional property `_embedded/last_deploy_operation/_links/deploy_image` to the response with the `200` status - added the optional property `_embedded/last_deploy_operation/deploy_image_id` to the response with the `200` status - added the optional property `_embedded/last_operation/_links/deploy_image` to the response with the `200` status - added the optional property `_embedded/last_operation/deploy_image_id` to the response with the `200` status - **2026-07-24** `1dc1e5b8c6eb`: 6 breaking, 1 warning, 2 info - the response property `_embedded/last_deploy_operation/env` became optional for the status `200` - the response property `_embedded/last_deploy_operation/private_key` became optional for the status `200` - the response property `_embedded/last_deploy_operation/sensitive_settings` became optional for the status `200` - the response property `_embedded/last_operation/env` became optional for the status `200` - …5 more - **2026-07-15** `5c71f4c63067`: 1 info - endpoint added [Operation history](https://skmtc.dev/aptible/apis/aptible-api-v1/changes/find/app/get.md) --- [API](https://skmtc.dev/aptible/apis/aptible-api-v1.md) - [All operations](https://skmtc.dev/aptible/apis/aptible-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/aptible/apis/aptible-api-v1/revisions/a21f6b1bc6fe?raw)