find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/oracle-email-ippool-tag-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: "Use the Email Delivery API to do the necessary set up to send high-volume and application-generated emails through the OCI Email Delivery service.\nFor more information, see [Overview of the Email Delivery Service](/iaas/Content/Email/Concepts/overview.htm).\n\n **Note:** Write actions (POST, UPDATE, DELETE) may take several minutes to propagate and be reflected by the API.\n If a subsequent read request fails to reflect your changes, wait a few minutes and try again.\n"
  license:
    name: Oracle Corporation
  title: Email Delivery ${email Ippool Tag} API
  version: '20170907'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/2b8421e2e819f20bff147090f9d2586190bb5c6d3b8562ffb01d9f9fa99542be.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Email Delivery API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/2b8421e2e819f20bff147090f9d2586190bb5c6d3b8562ffb01d9f9fa99542be.yaml
    what: the harvested document for Email Delivery API
servers:
- url: https://127.0.0.1/20170907
tags:
- name: ${email-ippool-tag}
paths:
  /emailIpPools:
    get:
      description: Returns a list of EmailIpPools.
      operationId: ListEmailIpPools
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/compartmentIdQueryParam'
      - $ref: '#/components/parameters/FilterByIdQueryParam'
      - $ref: '#/components/parameters/FilterByNameQueryParam'
      - description: 'Filter returned list by specified lifecycle state. This parameter is case-insensitive.

          '
        in: query
        name: lifecycleState
        required: false
        x-obmcs-enumref: '#/definitions/EmailIpPool/lifecycleState'
        schema:
          type: string
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - description: 'Specifies the attribute with which to sort the Email IpPools.


          Default: `TIMECREATED`


          * **TIMECREATED:** Sorts by timeCreated.

          '
        in: query
        name: sortBy
        required: false
        schema:
          type: string
          enum:
          - TIMECREATED
          - NAME
          default: TIMECREATED
      responses:
        200:
          description: Success
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain.

                For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailIpPoolCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Gets a list of all EmailIpPools in the specified compartment
      tags:
      - ${email-ippool-tag}
      x-example: 'GET /20170907/emailIpPools?compartmentId=ocid1.compartment.oc1...HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    post:
      description: Creates a new EmailIpPool.
      operationId: CreateEmailIpPool
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: Success
          headers:
            Content-Location:
              description: 'The full URI of the resource related to the request

                '
              schema:
                type: string
                format: uri-reference
            Location:
              description: 'The full URI of the resource related to the request

                '
              schema:
                type: string
                format: uri-reference
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailIpPool'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new EmailIpPool
      tags:
      - ${email-ippool-tag}
      x-example: 'POST /20170907/emailIpPools HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/EmailIpPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmailIpPoolDetails'
        description: Details for the new EmailIpPool.
        required: true
  /emailIpPools/{emailIpPoolId}:
    delete:
      description: Deletes an EmailIpPool resource by identifier
      operationId: DeleteEmailIpPool
      parameters:
      - $ref: '#/components/parameters/IpPoolIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: Accepted the request. The EmailIpPool will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a provisioned EmailIpPool
      tags:
      - ${email-ippool-tag}
      x-example: 'DELETE /20170907/emailIpPools/ocid1.emailippool.oc1... HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/EmailIpPool'
    get:
      description: Retrieves the specified IpPool by identifier
      operationId: GetEmailIpPool
      parameters:
      - $ref: '#/components/parameters/IpPoolIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the IpPool with the given id
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailIpPool'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get EmailIpPool
      tags:
      - ${email-ippool-tag}
      x-example: 'GET /20170907/emailIpPools/ocid1.emailippool.oc1... HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: Updates the EmailIpPool
      operationId: UpdateEmailIpPool
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IpPoolIdPathParam'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: Accepted the request. The IpPool will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the EmailIpPool identified by the id
      tags:
      - ${email-ippool-tag}
      x-example: 'PUT /20170907/emailIpPools/ocid1.emailippool.oc1... HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/EmailIpPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmailIpPoolDetails'
        description: The information to be updated.
        required: true
  /emailIpPools/{emailIpPoolId}/actions/addEmailOutboundIp:
    post:
      description: Add OutboundIps to EmailIpPool.
      operationId: AddEmailOutboundIp
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IpPoolIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. OutboundIPs will be added to EmailIpPool.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Add OutboundIps to EmailIpPool.
      tags:
      - ${email-ippool-tag}
      x-example: 'POST /20170907/emailIpPools/ocid1.emailippool.oc1.../actions/addEmailOutboundIp HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/EmailIpPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddEmailOutboundIpDetails'
        description: Details to add IPs to EmailIpPool.
        required: true
  /emailIpPools/{emailIpPoolId}/actions/addLock:
    post:
      description: Adds a lock to a resource.
      operationId: AddEmailIpPoolLock
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/IpPoolIdPathParam'
      responses:
        '200':
          description: Lock is added.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailIpPool'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Adds a lock to a resource.
      tags:
      - ${email-ippool-tag}
      x-related-resource: '#/definitions/EmailIpPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddLockDetails'
        description: Details for adding a lock to a resource.
        required: true
  /emailIpPools/{emailIpPoolId}/actions/changeCompartment:
    post:
      description: Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
      operationId: ChangeEmailIpPoolCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IpPoolIdPathParam'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: Accepted the request. The IpPool will be moved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
      summary: Moves a resource into a different compartment.
      tags:
      - ${email-ippool-tag}
      x-example: "POST /20170907/emailIpPools/ocid1.emailippool.oc1.../actions/changeCompartment HTTP/1.1\nHost: ctrl.email.us-phoenix-1.oci.oraclecloud.com\n <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/EmailIpPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeEmailIpPoolCompartmentDetails'
        description: Details for the compartment move.
        required: true
  /emailIpPools/{emailIpPoolId}/actions/removeEmailOutboundIp:
    post:
      description: Remove OutboundIps from EmailIpPool.
      operationId: RemoveEmailOutboundIp
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IpPoolIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. OutboundIPs will be removed from EmailIpPool.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Remove OutboundIps from EmailIpPool
      tags:
      - ${email-ippool-tag}
      x-example: 'POST /20170907/emailIpPools/ocid1.emailippool.oc1.../actions/removeEmailOutboundIp HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/EmailIpPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveEmailOutboundIpDetails'
        description: Details to remove IPs from EmailIpPool.
        required: true
  /emailIpPools/{emailIpPoolId}/actions/removeLock:
    post:
      description: Remove a lock to a resource.
      operationId: RemoveEmailIpPoolLock
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/IpPoolIdPathParam'
      responses:
        '200':
          description: Lock is Removed.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailIpPool'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Remove a lock to a resource.
      tags:
      - ${email-ippool-tag}
      x-related-resource: '#/definitions/EmailIpPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveLockDetails'
        description: Details for removing a lock to a resource.
        required: true
  /emailOutboundIps:
    get:
      description: Returns a list of all Outbound Public IPs assigned for a given tenant.
      operationId: ListEmailOutboundIps
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/compartmentIdQueryParam'
      - $ref: '#/components/parameters/FilterByOutboundIpQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - description: 'Filter returned list by specified lifecycle state. This parameter is case-insensitive.

          '
        in: query
        name: lifecycleState
        required: false
        x-obmcs-enumref: '#/definitions/EmailOutboundIpSummary/lifecycleState'
        schema:
          type: string
      - description: 'Filter returned list by specified assignment state.

          '
        in: query
        name: assignmentState
        required: false
        x-obmcs-enumref: '#/definitions/EmailOutboundIpSummary/assignmentState'
        schema:
          type: string
          default: AVAILABLE
      - description: 'The field to sort by. The `OUTBOUNDIP` value returns the list in

          ascending order or Outbound Ip address by default. Use the `SortOrderQueryParam` to change the

          direction of the returned list of items.

          '
        in: query
        name: sortBy
        required: false
        schema:
          type: string
          enum:
          - OUTBOUNDIP
          default: OUTBOUNDIP
      responses:
        200:
          description: Success
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain.

                For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailOutboundIpCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Gets a list of all Outbound Public IPs assigned for the given tenant.
      tags:
      - ${email-ippool-tag}
      x-example: 'GET /20170907/emailOutboundIps?compartmentId=ocid1.compartment.oc1...HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
components:
  schemas:
    ChangeEmailIpPoolCompartmentDetails:
      description: Information about the change compartment for the IpPool resource.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    CreateEmailIpPoolDetails:
      description: The configuration details required to create a new IpPool which will be used to route emails.
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this IpPool.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported as valid value type.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: The description of the IpPool. Avoid entering confidential information.
          maxLength: 400
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        lastIpDrainPeriodInHours:
          default: 24
          description: 'Last IP will be unassigned from the IP Pool after the period of time (in hours) specified by this parameter. Default is 24 hours.

            '
          maximum: 24
          minimum: 0
          type: integer
        name:
          description: "The name of the IpPool. The name must be unique within a region. \nThe name is case sensitive and supported characters include alphanumeric, hyphens (\"-\") and underscore (\"_\") characters.\n\nExample: green_pool-1\n"
          type: string
        outboundIps:
          description: A list of outbound public IPs for assignment to the IpPool. These IPs must be in the AVAILABLE state to be eligible for assignment.
          items:
            type: string
          maxItems: 3
          minItems: 1
          type: array
          uniqueItems: true
      required:
      - name
      - compartmentId
      - outboundIps
      type: object
      x-example: "{\n  \"name\": \"green_pool-1\"\n  \"compartmentId\": \"ocid1.compartment.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n}\n"
    AddEmailOutboundIpDetails:
      description: 'Outbound IP details to be assigned to the IpPool.

        '
      properties:
        outboundIps:
          description: 'List of public IPs to ADD to the IpPool.

            Public IPs must be in the AVAILABLE state to be assigned to the IpPool.

            '
          items:
            type: string
          maxItems: 3
          type: array
          uniqueItems: true
      required:
      - outboundIps
      type: object
    RemoveEmailOutboundIpDetails:
      description: 'Outbound IP details to be unassigned from the IpPool.

        '
      properties:
        outboundIps:
          description: "List of public IPs to REMOVE from the IpPool.\nAfter a public IP is unassigned, it will be marked as AVAILABLE and can be assigned to another IpPool. \nThe last IP removed from the Pool will be deleted from the IP Pool after 24 hours.\n"
          items:
            type: string
          maxItems: 3
          type: array
          uniqueItems: true
      required:
      - outboundIps
      type: object
    RemoveLockDetails:
      description: 'Request payload to remove the resource lock.

        '
      properties:
        compartmentId:
          description: The lock compartment ID.
          type: string
        type:
          description: Lock type.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    AddLockDetails:
      description: 'Request payload to add lock to the resource.

        '
      properties:
        compartmentId:
          description: The lock compartment ID.
          type: string
        message:
          description: 'A message added by the lock creator. The message typically gives an

            indication of why the resource is locked.

            '
          type: string
        relatedResourceId:
          description: 'The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.

            '
          type: string
        type:
          description: Lock type.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    UpdateEmailIpPoolDetails:
      description: The attributes to update an IpPool which will be used to route emails.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported as valid value type.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: The description of the IpPool. Avoid entering confidential information.
          maxLength: 400
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: 

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-email-ippool-tag-api-openapi.yml