{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0412bc1c-950b-4b74-b5c3-70c6eb02b18b","name":"Impulse Platform Dev API","description":"# Impulse Platform Dev API\n\nBuild and operate Impulse services through one project-scoped API. This development collection covers projects, organization security, Postgres, engine-neutral Objects, project-isolated Auth, engine-neutral Search, engine-neutral managed Secrets, and Redis-compatible TLS Cache services.\n\n> The dev contract can change before general availability. Never use development credentials for production workloads.\n\n## Base URL\n\n`https://api-dev.impulsehosting.com`\n\n## Authentication\n\nCustomer requests use a bearer token created from **My Impulse > Security > API Access**. Keys can target one project or every project in the organization and are restricted by explicit scopes.\n\n```http\nAuthorization: Bearer YOUR_IMPULSE_API_TOKEN\n```\n\nUse the **Impulse Platform Dev Docs** environment for safe examples. For live testing, keep `impulse-platform-dev-api-token` in Postman Local Vault and use the **Impulse Platform Dev** environment. Vault values remain local and are never published.\n\n## Resource model\n\n- **Organization** owns API keys and the IP allowlist.\n- **Project** groups subscribed services and bounds project-scoped keys.\n- **Service** is a Postgres, Objects, Auth, Search, Secrets, Cache, or future Platform primitive.\n- **Capability** advertises which actions the service and plan currently support.\n\n## Current dev primitives\n\n- **Postgres 1.0**: shared and dedicated operations, backups, migrations, extensions, PgBouncer, replicas, diagnostics, and version management.\n- **Objects 1.0**: engine-neutral S3-compatible buckets, objects, scoped keys, versioning, signed transfer, usage, credential rotation, and automatic WHMCS lifecycle reconciliation.\n- **Auth 1.0**: project health, usage, users, roles, sessions, audit, and credential rotation without exposing JWT signing secrets.\n- **Search 1.0**: health, usage, logical indexes, bounded queries, key metadata and rotation, tenant credentials, tasks, snapshots, and customer domains without exposing backend identity.\n- **Secrets 1.0**: health, usage, logical namespaces, metadata listing, single-secret write, explicit reveal, and delete with independent least-privilege scopes.\n- **Cache 1.0**: shared and dedicated cache health, configuration, metrics, service allowlists, credential rotation, confirmed flush, and customer-safe snapshots without exposing node topology or runtime engine details.\n\nExisting eligible subscriptions attach automatically after the customer creates the first API key. Manual entitlement sync and attach are support recovery operations rather than normal API setup.\n\n## Safety\n\nRequests marked **optional** or described as destructive can rotate credentials, restore data, delete resources, revoke sessions, or change runtime state. Use isolated dev services and review the request description before sending them.\n\nCanonical contracts and lifecycle notes live in the `impulse-platform` repository under `docs/api`.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"56465977","team":22770206,"collectionId":"0412bc1c-950b-4b74-b5c3-70c6eb02b18b","publishedId":"2sBY4LSMtb","public":true,"publicUrl":"https://api-docs-dev.impulsehosting.com","privateUrl":"https://go.postman.co/documentation/56465977-0412bc1c-950b-4b74-b5c3-70c6eb02b18b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2563EB"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Development API reference for Impulse Postgres, Objects, Auth, project management, organization security, and service lifecycle operations."},{"name":"title","value":"Impulse Platform Dev API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"60A5FA"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2563EB"}}]}},"version":"8.12.6","publishDate":"2026-07-12T05:26:31.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Impulse Platform Dev API Documentation","description":"Development API reference for Impulse Postgres, Objects, Auth, project management, organization security, and service lifecycle operations."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Impulse Platform Dev Docs","id":"3046307c-b828-4631-bfc4-53a150fdb4ca","owner":"56465977","values":[{"key":"base_url","value":"https://api-dev.impulsehosting.com","enabled":true,"type":"default"},{"key":"api_token","value":"YOUR_IMPULSE_API_TOKEN","enabled":true,"type":"default"},{"key":"allowlist_cidr","value":"203.0.113.0/24","enabled":true,"type":"default"},{"key":"allowlist_label","value":"Example office","enabled":true,"type":"default"},{"key":"allowlist_entry_id","value":"YOUR_ALLOWLIST_ENTRY_ID","enabled":true,"type":"default"},{"key":"project_id","value":"YOUR_PROJECT_ID","enabled":true,"type":"default"},{"key":"service_id","value":"YOUR_POSTGRES_SERVICE_ID","enabled":true,"type":"default"},{"key":"service_type","value":"postgres","enabled":true,"type":"default"},{"key":"service_plan","value":"starter","enabled":true,"type":"default"},{"key":"service_name","value":"example-postgres","enabled":true,"type":"default"},{"key":"service_action","value":"backup_now","enabled":true,"type":"default"},{"key":"dedicated_service_id","value":"YOUR_DEDICATED_POSTGRES_SERVICE_ID","enabled":true,"type":"default"},{"key":"objects_service_id","value":"YOUR_OBJECTS_SERVICE_ID","enabled":true,"type":"default"},{"key":"auth_service_id","value":"YOUR_AUTH_SERVICE_ID","enabled":true,"type":"default"},{"key":"auth_primary_service_id","value":"YOUR_PRIMARY_AUTH_SERVICE_ID","enabled":true,"type":"default"},{"key":"backup_filename","value":"YOUR_BACKUP_FILENAME","enabled":true,"type":"default"},{"key":"backup_download_url","value":"https://signed-backup-download.example","enabled":true,"type":"default"},{"key":"database_export_url","value":"https://signed-database-export.example","enabled":true,"type":"default"},{"key":"extension_name","value":"pg_trgm","enabled":true,"type":"default"},{"key":"target_version","value":"17","enabled":true,"type":"default"},{"key":"postgres_new_name","value":"example_database","enabled":true,"type":"default"},{"key":"migration_host","value":"source-db.example.com","enabled":true,"type":"default"},{"key":"migration_port","value":"5432","enabled":true,"type":"default"},{"key":"migration_username","value":"source_user","enabled":true,"type":"default"},{"key":"migration_password","value":"YOUR_SOURCE_DATABASE_PASSWORD","enabled":true,"type":"default"},{"key":"migration_database","value":"source_database","enabled":true,"type":"default"},{"key":"migration_ssl_required","value":"true","enabled":true,"type":"default"},{"key":"postgres_service_allow_ip","value":"203.0.113.10/32","enabled":true,"type":"default"},{"key":"postgres_service_allow_label","value":"Example application","enabled":true,"type":"default"},{"key":"query_pid","value":"YOUR_QUERY_PID","enabled":true,"type":"default"},{"key":"pool_suffix","value":"app","enabled":true,"type":"default"},{"key":"pool_mode","value":"transaction","enabled":true,"type":"default"},{"key":"pool_size","value":"10","enabled":true,"type":"default"},{"key":"pool_user_id","value":"YOUR_POOL_USER_ID","enabled":true,"type":"default"},{"key":"replica_region","value":"dfw","enabled":true,"type":"default"},{"key":"replica_id","value":"YOUR_REPLICA_ID","enabled":true,"type":"default"},{"key":"objects_bucket","value":"example-bucket","enabled":true,"type":"default"},{"key":"objects_bucket_label","value":"Example bucket","enabled":true,"type":"default"},{"key":"objects_secondary_bucket","value":"example-secondary-bucket","enabled":true,"type":"default"},{"key":"objects_access_key_id","value":"YOUR_SCOPED_ACCESS_KEY_ID","enabled":true,"type":"default"},{"key":"objects_folder","value":"uploads","enabled":true,"type":"default"},{"key":"objects_object_key","value":"uploads/hello.txt","enabled":true,"type":"default"},{"key":"objects_upload_url","value":"https://signed-object-upload.example","enabled":true,"type":"default"},{"key":"objects_download_url","value":"https://signed-object-download.example","enabled":true,"type":"default"},{"key":"objects_continuation_token","value":"YOUR_CONTINUATION_TOKEN","enabled":true,"type":"default"},{"key":"objects_usage_metric","value":"storage","enabled":true,"type":"default"},{"key":"objects_usage_range","value":"7d","enabled":true,"type":"default"},{"key":"auth_user_id","value":"YOUR_AUTH_USER_ID","enabled":true,"type":"default"},{"key":"auth_user_email","value":"api-user@example.com","enabled":true,"type":"default"},{"key":"auth_user_password","value":"GENERATE_A_STRONG_TEMPORARY_PASSWORD","enabled":true,"type":"default"},{"key":"auth_user_full_name","value":"Example API User","enabled":true,"type":"default"},{"key":"auth_role","value":"member","enabled":true,"type":"default"},{"key":"auth_session_id","value":"YOUR_AUTH_SESSION_ID","enabled":true,"type":"default"},{"key":"auth_identity_id","value":"YOUR_AUTH_IDENTITY_ID","enabled":true,"type":"default"},{"key":"auth_export_limit","value":"1000","enabled":true,"type":"default"},{"key":"search_primary_service_id","value":"YOUR_PRIMARY_SEARCH_SERVICE_ID","enabled":true,"type":"default"},{"key":"search_service_id","value":"YOUR_SEARCH_SERVICE_ID","enabled":true,"type":"default"},{"key":"search_index","value":"api-smoke","enabled":true,"type":"default"},{"key":"search_query","value":"chair","enabled":true,"type":"default"},{"key":"search_tenant_field","value":"_impulse_tenant","enabled":true,"type":"default"},{"key":"search_tenant_value","value":"tenant-example","enabled":true,"type":"default"},{"key":"search_task_id","value":"YOUR_SEARCH_TASK_ID","enabled":true,"type":"default"},{"key":"search_snapshot_id","value":"YOUR_SEARCH_SNAPSHOT_ID","enabled":true,"type":"default"},{"key":"search_domain","value":"search-api.example.com","enabled":true,"type":"default"},{"key":"search_domain_id","value":"YOUR_SEARCH_DOMAIN_ID","enabled":true,"type":"default"},{"key":"secrets_service_id","value":"YOUR_SECRETS_SERVICE_ID","enabled":true,"type":"default"},{"key":"secrets_namespace","value":"dev","enabled":true,"type":"default"},{"key":"secrets_path","value":"/api-smoke","enabled":true,"type":"default"},{"key":"secrets_key","value":"POSTMAN_SMOKE_VALUE","enabled":true,"type":"default"},{"key":"secrets_value","value":"YOUR_DISPOSABLE_SECRET_VALUE","enabled":true,"type":"default"},{"key":"cache_primary_service_id","value":"YOUR_PRESERVED_CACHE_SERVICE_ID","enabled":true,"type":"default"},{"key":"cache_service_id","value":"YOUR_DISPOSABLE_CACHE_SERVICE_ID","enabled":true,"type":"default"},{"key":"cache_service_allow_ip","value":"203.0.113.10/32","enabled":true,"type":"default"},{"key":"cache_service_allow_label","value":"Example application","enabled":true,"type":"default"},{"key":"cache_snapshot_id","value":"YOUR_CACHE_SNAPSHOT_ID","enabled":true,"type":"default"},{"key":"cache_restore_guard","value":"RESTORE DISPOSABLE CACHE","enabled":true,"type":"default"},{"key":"cache_flush_guard","value":"FLUSH DISPOSABLE CACHE","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f9dcdcf44fbdb1963cd888fd96b40426ad7330a96ea8f131714b66f4a58d1d68","favicon":"https://impulsehosting.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Impulse Platform Dev Docs","value":"56465977-3046307c-b828-4631-bfc4-53a150fdb4ca"}],"canonicalUrl":"https://api-docs-dev.impulsehosting.com/view/metadata/2sBY4LSMtb"}