{ "opencollection": "1.0.0", "info": { "name": "Email Delivery ${sender Tag} ${sender Tag} API", "version": "20170907" }, "items": [ { "info": { "name": "${sender-tag}", "type": "folder" }, "items": [ { "info": { "name": "Get a list of approved sender summaries.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20170907/senders", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID for the compartment." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of a sender." }, { "name": "domain", "value": "", "type": "query", "description": "A filter to only return resources that match the given domain exactly." }, { "name": "emailAddress", "value": "", "type": "query", "description": "The email address of the approved sender." }, { "name": "emailIpPoolId", "value": "", "type": "query", "description": "A filter to only return resources that match the given IpPool resource exactly." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. `1` is the minimum, `1000` is the maximum. For important details about\nhow pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. The `TIMECREATED` value returns the list in in\ndescending order by default. The `EMAILADDRESS` value returns the list in\nascending order by default. Use the `SortOrderQueryParam` to change the\ndirection of the returned list of items.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending or descending order.\n" } ] }, "docs": "Gets a collection of approved sender email addresses and sender IDs.\n" }, { "info": { "name": "Creates a sender for a tenancy in a given compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20170907/senders", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a sender for a tenancy in a given compartment." }, { "info": { "name": "Gets an approved sender.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20170907/senders/:senderId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "senderId", "value": "", "type": "path", "description": "The unique OCID of the sender." } ] }, "docs": "Gets an approved sender for a given `senderId`." }, { "info": { "name": "Updates the tags for a given sender.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20170907/senders/:senderId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "senderId", "value": "", "type": "path", "description": "The unique OCID of the sender." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the set of tags for a sender with the tags provided. If either freeform\nor defined tags are omitted, the tags for that set remain the same. Each set must\ninclude the full set of tags for the sender, partial updates are not permitted.\nFor more information about tagging, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n" }, { "info": { "name": "Deletes a sender for a tenancy in a given compartment.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20170907/senders/:senderId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "senderId", "value": "", "type": "path", "description": "The unique OCID of the sender." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes an approved sender for a tenancy in a given compartment for a\nprovided `senderId`.\n" }, { "info": { "name": "Adds a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20170907/senders/:senderId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "senderId", "value": "", "type": "path", "description": "The unique OCID of the sender." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a lock to a resource." }, { "info": { "name": "Moves a sender into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20170907/senders/:senderId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "senderId", "value": "", "type": "path", "description": "The unique OCID of the sender." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Remove a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20170907/senders/:senderId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "senderId", "value": "", "type": "path", "description": "The unique OCID of the sender." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a lock to a resource." } ] } ], "bundled": true }