Oracle Service API

openapi: 3.2.0
info:
  description: Manage Oracle Cloud Infrastructure console announcements.
  title: Announcements Service API
  version: 0.0.1
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/ad81e510c25e589a2fdfbfe0fb957253a658175b2922b7951ddb17b4910c849b.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Announcements Service 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/ad81e510c25e589a2fdfbfe0fb957253a658175b2922b7951ddb17b4910c849b.yaml
    what: the harvested document for Announcements Service API
servers:
- url: http://127.0.0.1/20180904
- url: https://127.0.0.1/20180904
tags:
- name: service
paths:
  /services:
    get:
      description: 'List all active services

        '
      operationId: ListServices
      parameters:
      - $ref: '#/components/parameters/PlatformTypeQueryParam'
      - $ref: '#/components/parameters/CommsManagerNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/ServiceSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of all Active services created by all comms managers.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/ServicesCollection'
        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: List all services
      tags:
      - service
      x-example: 'GET /20180904/services?compartmentId=<var>&lt;compartmentId&gt;</var>

        Host: announcements.us-ashburn-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/Service'
components:
  parameters:
    CompartmentIdQueryParam:
      description: 'The OCID of the compartment.

        '
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 512
        minLength: 1
    PlatformTypeQueryParam:
      description: A filter to return only announcements affecting a specific platform.
      in: query
      name: platformType
      x-default-description: No default value for PlatformType
      schema:
        type: string
        enum:
        - IAAS
        - SAAS
        - PAAS
        maxLength: 64
        minLength: 1
    ServiceSortByQueryParam:
      description: Sort by service name parameter
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - serviceName
        default: serviceName
    PaginationTokenQueryParam:
      description: The value of the `opc-next-page` response header from the previous "List" call.
      in: query
      name: page
      schema:
        type: string
        maxLength: 3000
        minLength: 1
    CommsManagerNameQueryParam:
      description: Filter by comms manager name
      in: query
      name: commsManagerName
      x-default-description: No filtering by commsManagerName by default
      x-obmcs-top-level-enum: '#/definitions/CommsManagerName'
      schema:
        type: string
        enum:
        - CN
        - FUSION
        - AS
        - ERF
    RequestIdHeader:
      description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about

        a particular request, please provide the complete request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return in a paginated "List" call.
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    SortOrderQueryParam:
      description: The sort order to use, whether ascending ('ASC') or descending ('DESC').
      in: query
      name: sortOrder
      x-default-description: 'The default value depends upon `sortBy`, and

        in general is ''DESC'' when sorting by time and ''ASC'' otherwise.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
  schemas:
    ServicesCollection:
      description: Collection of all services.
      properties:
        items:
          description: List of all services.
          items:
            $ref: '#/components/schemas/ServiceSummary'
          type: array
      required:
      - items
    BaseService:
      description: Object representing a single service.
      discriminator:
        propertyName: type
      properties:
        commsManagerName:
          description: Name of the comms manager team that manages Notifications to this service.
          enum:
          - CN
          - FUSION
          - AS
          - ERF
          type: string
          x-obmcs-top-level-enum: '#/definitions/CommsManagerName'
        excludedRealms:
          description: The list of realms where this service is not available to be used.
          items:
            type: string
          type: array
        id:
          description: ID of the service object.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Current state of the service object.
          enum:
          - ACTIVE
          - DELETED
          type: string
        platformType:
          description: The platform type this service object is related to.
          enum:
          - IAAS
          - SAAS
          - PAAS
          type: string
          x-obmcs-top-level-enum: '#/definitions/PlatformType'
        previousServiceNames:
          description: The list of previously used names for this service object.
          items:
            type: string
          type: array
        serviceName:
          description: Name of the service represented by this object.
          maxLength: 255
          minLength: 1
          type: string
        shortName:
          description: Short name of the team to whom this service object is related.
          maxLength: 150
          minLength: 1
          type: string
        teamName:
          description: Team name to which this service object is related.
          maxLength: 150
          minLength: 1
          type: string
        timeCreated:
          description: The date and time when the service object was created.
          format: date-time
          type: string
        timeUpdated:
          description: The date and time when the service object was updated.
          format: date-time
          type: string
        type:
          description: The discriminator property.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - type
      - id
      - serviceName
      - shortName
      - teamName
      - platformType
      - commsManagerName
      - excludedRealms
      - previousServiceNames
    ServiceSummary:
      allOf:
      - $ref: '#/components/schemas/BaseService'
      - discriminator: ServiceSummary
      description: Summary of the service object.
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
  responses:
    default:
      description: Unknown Error
      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
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-previous-page:
      description: 'For pagination of a list of items. Include this value as the `page` parameter for the

        subsequent GET request to get the previous batch of items.

        '
      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.

        '
      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.

        '
      type: string
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          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.

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

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

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

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: false
x-oracle-package: com.oracle.pic.announcements.announcements-api