{
  "opencollection": "1.0.0",
  "info": {
    "name": "Email Delivery ${dkim Tag} ${dkim Tag} API",
    "version": "20170907"
  },
  "items": [
    {
      "info": {
        "name": "${dkim-tag}",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists DKIMs for an email domain.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://127.0.0.1/20170907/dkims",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "emailDomainId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the email domain to which this DKIM belongs.\n"
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "A filter to only return resources that match the given id exactly.\n"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "A filter to only return resources that match the given name exactly.\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": "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": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either ascending or descending order.\n"
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "Filter returned list by specified lifecycle state. This parameter is case-insensitive.\n"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Specifies the attribute with which to sort the DKIMs.\n\nDefault: `TIMECREATED`\n\n* **TIMECREATED:** Sorts by timeCreated.\n* **NAME:** Sorts by name.\n* **ID:** Sorts by id.\n"
              }
            ]
          },
          "docs": "Lists DKIMs for an email domain."
        },
        {
          "info": {
            "name": "Creates a new DKIM for an email domain.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://127.0.0.1/20170907/dkims",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new DKIM for an email domain.\nThis DKIM signs all approved senders in the tenancy that are in this email domain.\nBest security practices indicate to periodically rotate the DKIM that is doing the signing.\nWhen a second DKIM is applied, all senders seamlessly pick up the new key\nwithout interruption in signing.\n"
        },
        {
          "info": {
            "name": "Retrieves the specified DKIM.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://127.0.0.1/20170907/dkims/:dkimId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "dkimId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this DKIM."
              }
            ]
          },
          "docs": "Retrieves the specified DKIM."
        },
        {
          "info": {
            "name": "Modifies a DKIM.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://127.0.0.1/20170907/dkims/:dkimId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "dkimId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this DKIM."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies a DKIM."
        },
        {
          "info": {
            "name": "Deletes a DKIM.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://127.0.0.1/20170907/dkims/:dkimId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "dkimId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this DKIM."
              }
            ]
          },
          "docs": "Deletes a DKIM.\nIf this key is currently the active key for the email domain, deleting the key\nwill stop signing the domain's outgoing mail.\nDKIM keys are left in DELETING state for about a day to allow DKIM signatures on\nin-transit mail to be validated.\nConsider creating a new DKIM for this domain so the signing can be rotated to it instead of deletion.\n"
        }
      ]
    }
  ],
  "bundled": true
}