3GPP ECS Address Configuration Information Sets (Collection) API

openapi: 3.2.0
info:
  title: 3gpp-ecs-address ECS Address Configuration Information Sets (Collection) API
  version: 1.1.0
  description: "API for AF provisioned ECS Address Configuration Information.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-ecs-address/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: ECS Address Configuration Information Sets (Collection)
paths:
  /{afId}/configurations:
    parameters:
    - name: afId
      in: path
      description: Represents the identifier of the AF.
      required: true
      schema:
        type: string
    get:
      summary: Retrieve all the active ECS Address Configuration Information Set(s).
      operationId: ReadEACIs
      tags:
      - ECS Address Configuration Information Sets (Collection)
      responses:
        '200':
          description: 'OK. All the Individual ECS Address Configuration Information Set resource(s) managed by the NEF are returned. If there are no active Individual ECS Address Configuration Information Set resources at the NEF, an empty array is returned.

            '
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EcsAddrInfo'
                minItems: 0
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '406':
          $ref: TS29122_CommonData.yaml#/components/responses/406
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    post:
      summary: Create a new ECS Address Configuration Information Set.
      operationId: CreateEACI
      tags:
      - ECS Address Configuration Information Sets (Collection)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EcsAddrInfo'
      responses:
        '201':
          description: 'Created. A representation of the created Individual ECS Address Configuration  Information Set resource is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EcsAddrInfo'
          headers:
            Location:
              description: Contains the URI of the newly created resource.
              required: true
              schema:
                type: string
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
components:
  schemas:
    EcsAddrInfo:
      description: Represents an ECS Address Configuration Information Set.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        ecsServerAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/EcsServerAddr
        spatialValidityCond:
          $ref: TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        ecsAuthMethods:
          type: array
          items:
            $ref: TS29503_Nudm_PP.yaml#/components/schemas/EcsAuthMethod
          minItems: 1
        supportedPlmns:
          type: array
          items:
            $ref: TS29503_Nudm_PP.yaml#/components/schemas/SupportedPlmn
          minItems: 1
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - ecsServerAddr
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: '3GPP TS 29.522 V19.5.0; 5G System; Network Exposure Function Northbound APIs.

    '
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/