{ "uuid": "2a3b8a7f-ebd6-4c4e-b009-4b311f56b111", "lastMigration": 29, "name": "API Keys API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "2f2a6444-6991-4522-b89a-0b203da1d80c", "documentation": "Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the `apikeys.keys.lookup` permission on the parent project.", "method": "get", "endpoint": "v2/keys:lookupKey", "responses": [ { "uuid": "44ab0e12-fa50-45fb-bf7a-77c0b17ca68e", "body": "{\n \"name\": \"\",\n \"parent\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d352efad-bb0c-4d0f-a178-87473237458f", "documentation": "Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "method": "delete", "endpoint": "v2/:name", "responses": [ { "uuid": "dfbdd294-5d17-4d24-94cd-e2203c059b55", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "894d6219-851b-429e-91b8-8450a5203479", "documentation": "Gets the metadata for an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "method": "get", "endpoint": "v2/:name", "responses": [ { "uuid": "41b6f4e5-f3e6-4592-b956-1faec9884cbc", "body": "{\n \"annotations\": {},\n \"createTime\": \"\",\n \"deleteTime\": \"\",\n \"displayName\": \"\",\n \"etag\": \"\",\n \"keyString\": \"\",\n \"name\": \"\",\n \"restrictions\": {\n \"androidKeyRestrictions\": {\n \"allowedApplications\": [\n {\n \"packageName\": \"\",\n \"sha1Fingerprint\": \"\"\n }\n ]\n },\n \"apiTargets\": [\n {\n \"methods\": [\n \"\"\n ],\n \"service\": \"\"\n }\n ],\n \"browserKeyRestrictions\": {\n \"allowedReferrers\": [\n \"\"\n ]\n },\n \"iosKeyRestrictions\": {\n \"allowedBundleIds\": [\n \"\"\n ]\n },\n \"serverKeyRestrictions\": {\n \"allowedIps\": [\n \"\"\n ]\n }\n },\n \"uid\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "437af1b6-25d6-4380-a049-b97fb13650be", "documentation": "Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "method": "patch", "endpoint": "v2/:name", "responses": [ { "uuid": "6e96f4c7-da82-4232-8fc6-f022e4f748c4", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e573147a-1dc9-45cd-89e5-2b08f9e7df50", "documentation": "Get the key string for an API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "method": "get", "endpoint": "v2/:name/keyString", "responses": [ { "uuid": "c1eccecd-dd99-48b0-ba9f-222485f69018", "body": "{\n \"keyString\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6026c302-08ba-4e2d-b918-0fb92f792e5c", "documentation": "Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "method": "post", "endpoint": "v2/:name:undelete", "responses": [ { "uuid": "cf447c38-557a-4db3-bcc6-8bec65c2f7fe", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "389d0e72-6c78-4a95-a517-5ec6d8f56de8", "documentation": "Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "method": "get", "endpoint": "v2/:parent/keys", "responses": [ { "uuid": "312deacd-dd46-493e-a9bf-07142faabec1", "body": "{\n \"keys\": [\n {\n \"annotations\": {},\n \"createTime\": \"\",\n \"deleteTime\": \"\",\n \"displayName\": \"\",\n \"etag\": \"\",\n \"keyString\": \"\",\n \"name\": \"\",\n \"restrictions\": {\n \"androidKeyRestrictions\": {\n \"allowedApplications\": [\n {\n \"packageName\": \"\",\n \"sha1Fingerprint\": \"\"\n }\n ]\n },\n \"apiTargets\": [\n {\n \"methods\": [\n \"\"\n ],\n \"service\": \"\"\n }\n ],\n \"browserKeyRestrictions\": {\n \"allowedReferrers\": [\n \"\"\n ]\n },\n \"iosKeyRestrictions\": {\n \"allowedBundleIds\": [\n \"\"\n ]\n },\n \"serverKeyRestrictions\": {\n \"allowedIps\": [\n \"\"\n ]\n }\n },\n \"uid\": \"\",\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d2fe1489-ad70-4bcf-a3fc-64ee8951c570", "documentation": "Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "method": "post", "endpoint": "v2/:parent/keys", "responses": [ { "uuid": "fac2ebe8-833c-400b-9c7a-dc29baedb15b", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "2f2a6444-6991-4522-b89a-0b203da1d80c" }, { "type": "route", "uuid": "d352efad-bb0c-4d0f-a178-87473237458f" }, { "type": "route", "uuid": "894d6219-851b-429e-91b8-8450a5203479" }, { "type": "route", "uuid": "437af1b6-25d6-4380-a049-b97fb13650be" }, { "type": "route", "uuid": "e573147a-1dc9-45cd-89e5-2b08f9e7df50" }, { "type": "route", "uuid": "6026c302-08ba-4e2d-b918-0fb92f792e5c" }, { "type": "route", "uuid": "389d0e72-6c78-4a95-a517-5ec6d8f56de8" }, { "type": "route", "uuid": "d2fe1489-ad70-4bcf-a3fc-64ee8951c570" } ] }