{ "uuid": "6dbc265e-4b8c-4040-857e-733083dc4612", "lastMigration": 29, "name": "Essential Contacts API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "f340b872-f6a0-4c96-8859-95c2c0821e61", "documentation": "Deletes a contact.", "method": "delete", "endpoint": "v1/:name", "responses": [ { "uuid": "df991156-b434-47ed-94aa-753c13178fe1", "body": "{}", "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": "205bb57e-047a-4998-8c06-f02b4e62c9dc", "documentation": "Gets a single contact.", "method": "get", "endpoint": "v1/:name", "responses": [ { "uuid": "fc8e66dc-b796-49e5-9cc6-28086291fbcb", "body": "{\n \"email\": \"\",\n \"languageTag\": \"\",\n \"name\": \"\",\n \"notificationCategorySubscriptions\": [\n \"{{oneOf (array 'NOTIFICATION_CATEGORY_UNSPECIFIED' 'ALL' 'SUSPENSION' 'SECURITY' 'TECHNICAL' 'BILLING' 'LEGAL' 'PRODUCT_UPDATES' 'TECHNICAL_INCIDENTS')}}\"\n ],\n \"validateTime\": \"\",\n \"validationState\": \"{{oneOf (array 'VALIDATION_STATE_UNSPECIFIED' 'VALID' 'INVALID')}}\"\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": "d5960122-9daf-4f07-848f-76ed989c4e89", "documentation": "Updates a contact. Note: A contact's email address cannot be changed.", "method": "patch", "endpoint": "v1/:name", "responses": [ { "uuid": "cc636bd0-5f60-4a45-b253-13cff4690dff", "body": "{\n \"email\": \"\",\n \"languageTag\": \"\",\n \"name\": \"\",\n \"notificationCategorySubscriptions\": [\n \"{{oneOf (array 'NOTIFICATION_CATEGORY_UNSPECIFIED' 'ALL' 'SUSPENSION' 'SECURITY' 'TECHNICAL' 'BILLING' 'LEGAL' 'PRODUCT_UPDATES' 'TECHNICAL_INCIDENTS')}}\"\n ],\n \"validateTime\": \"\",\n \"validationState\": \"{{oneOf (array 'VALIDATION_STATE_UNSPECIFIED' 'VALID' 'INVALID')}}\"\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": "055b8b1b-6e44-441f-84ed-9a0e73ad6598", "documentation": "Lists the contacts that have been set on a resource.", "method": "get", "endpoint": "v1/:parent/contacts", "responses": [ { "uuid": "db40bc80-a67b-49ec-aa26-65c66b352c9b", "body": "{\n \"contacts\": [\n {\n \"email\": \"\",\n \"languageTag\": \"\",\n \"name\": \"\",\n \"notificationCategorySubscriptions\": [\n \"{{oneOf (array 'NOTIFICATION_CATEGORY_UNSPECIFIED' 'ALL' 'SUSPENSION' 'SECURITY' 'TECHNICAL' 'BILLING' 'LEGAL' 'PRODUCT_UPDATES' 'TECHNICAL_INCIDENTS')}}\"\n ],\n \"validateTime\": \"\",\n \"validationState\": \"{{oneOf (array 'VALIDATION_STATE_UNSPECIFIED' 'VALID' 'INVALID')}}\"\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": "52e85421-158a-4784-9670-a43b4a93c8de", "documentation": "Adds a new contact for a resource.", "method": "post", "endpoint": "v1/:parent/contacts", "responses": [ { "uuid": "2d59b3bb-1194-4249-a707-3b0c7c80e42b", "body": "{\n \"email\": \"\",\n \"languageTag\": \"\",\n \"name\": \"\",\n \"notificationCategorySubscriptions\": [\n \"{{oneOf (array 'NOTIFICATION_CATEGORY_UNSPECIFIED' 'ALL' 'SUSPENSION' 'SECURITY' 'TECHNICAL' 'BILLING' 'LEGAL' 'PRODUCT_UPDATES' 'TECHNICAL_INCIDENTS')}}\"\n ],\n \"validateTime\": \"\",\n \"validationState\": \"{{oneOf (array 'VALIDATION_STATE_UNSPECIFIED' 'VALID' 'INVALID')}}\"\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": "92a855d0-7cd4-4068-ba72-69ecb0d87d6c", "documentation": "Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.", "method": "get", "endpoint": "v1/:parent/contacts:compute", "responses": [ { "uuid": "c7dce4f9-a028-4f80-84de-ff43e2696abf", "body": "{\n \"contacts\": [\n {\n \"email\": \"\",\n \"languageTag\": \"\",\n \"name\": \"\",\n \"notificationCategorySubscriptions\": [\n \"{{oneOf (array 'NOTIFICATION_CATEGORY_UNSPECIFIED' 'ALL' 'SUSPENSION' 'SECURITY' 'TECHNICAL' 'BILLING' 'LEGAL' 'PRODUCT_UPDATES' 'TECHNICAL_INCIDENTS')}}\"\n ],\n \"validateTime\": \"\",\n \"validationState\": \"{{oneOf (array 'VALIDATION_STATE_UNSPECIFIED' 'VALID' 'INVALID')}}\"\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": "f62fc1e2-f221-4a6a-ba1a-3c6c04c32b49", "documentation": "Allows a contact admin to send a test message to contact to verify that it has been configured correctly.", "method": "post", "endpoint": "v1/:resource/contacts:sendTestMessage", "responses": [ { "uuid": "58219e3d-a448-4eb7-be2a-686473a91ec3", "body": "{}", "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": "f340b872-f6a0-4c96-8859-95c2c0821e61" }, { "type": "route", "uuid": "205bb57e-047a-4998-8c06-f02b4e62c9dc" }, { "type": "route", "uuid": "d5960122-9daf-4f07-848f-76ed989c4e89" }, { "type": "route", "uuid": "055b8b1b-6e44-441f-84ed-9a0e73ad6598" }, { "type": "route", "uuid": "52e85421-158a-4784-9670-a43b4a93c8de" }, { "type": "route", "uuid": "92a855d0-7cd4-4068-ba72-69ecb0d87d6c" }, { "type": "route", "uuid": "f62fc1e2-f221-4a6a-ba1a-3c6c04c32b49" } ] }