ETSI Operator Platform Open Exposure Gateway API is one of 24 APIs that ETSI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include CAMARA, GSMA, Operator Platform, Edge Computing, and Federation. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes
20 operations
across 14 paths,
organized into 5 resource areas,
and defines 83 schemas.
It is described by OpenAPI 3.0.3, at version 1.0.1-wip.
Requests are made against a single base URL, http://vitrualserver:8080/oeg/1.0.0.
The identity and technical contract details declared by the specification.
QoDSchema
object
7 properties
TrafficInfluenceSchema
object
10 properties
RetrievalLocationRequest
object
3 properties
Device
object
4 properties
DeviceIpv4Addr
object
3 properties
LocationResponse
object
2 properties
LocationArea
object
Geographic area of the location (Circle or Polygon).
4 properties
GeoPoint
object
2 properties
AccessEndpoint
object
Application Endpoint for an especific instance that is running in an specific Edge Cloud Zone.
4 properties
1 required
AppId
string
A globally unique identifier associated with the application. Edge Cloud Platform generates this identifier when the Application is submitted.
AppInstanceId
string
A globally unique identifier associated with a running instance of an application. Edge Cloud Platform generates this identifier when the instantiation in the…
AppInstanceName
string
Name of the App instance, scoped to the AppProvider
AppInstanceInfo
object
Information about the application instance.
5 properties
AppZones
array
Collection of Edge Cloud Zones and/or Kubernetes cluster reference where the Application Provider wants to instantiate the application.
1 required
AppManifest
object
Application information and requirements provided by the Application Provider
9 properties
5 required
AppProvider
string
Human readable name of the Application Provider.
AppIdentifier
string
Identifier used to refer to an application.
AppProviderId
string
UserId of the app provider. Identifier is relevant only in context of this federation.
ArtefactId
string
A globally unique identifier associated with the artefact. Originating OP generates this identifier when artefact is submitted over NBI.
CountryCode
string
ISO 3166-1 Alpha-2 code for the country of Partner operator
CPUArchType
string
CPU Instruction Set Architecture (ISA) E.g., Intel, Arm etc.
CallbackCredentials
object
Authentication credentials for callbacks. Callbacks use the same security scheme, flows, and scopes as the forward path.
3 properties
3 required
GeoLocation
string
Latitude,Longitude as decimal fraction up to 4 digit precision
InstanceIdentifier
string
Unique identifier generated by the partner OP to identify an instance of the application on a specific zone.
InstanceState
string
Running status of the application instance.
inline_response_200
object
1 property
1 required
inline_response_200_1
object
5 properties
2 required
inline_response_200_2
object
1 property
1 required
EdgeCloudProvider
string
Human readable name of the Edge Cloud Provider.
EdgeCloudRegion
string
Human readable name of the geographical Edge Cloud Region of the Edge Cloud. Defined by the Edge Cloud Provider.
EdgeCloudZones
array
A collection of Edge Cloud Zones where the Application Provider can instantiate an Application Instance.
ZoneObject
object
1 property
1 required
EdgeCloudZoneId
string
Unique identifier created by the Edge Cloud Platform to identify an Edge Cloud Zone within an Edge Cloud.
EdgeCloudZone
object
An Edge Cloud Zone, uniquely identified by a combination of the value of the Edge Cloud Zone Id object and the value of the Edge Cloud Provider object. This va…
5 properties
3 required
EdgeCloudZoneName
string
Human readable name of the geographical zone of the Edge Cloud. Defined by the Edge Cloud Provider.
EdgeCloudZoneStatus
string
Status of the Edge Cloud Zone (default is 'unknown')
ErrorInfo
object
Information about the error
3 properties
3 required
FederationAPINames
string
HttpResources
object
2 properties
2 required
FederationAPIResources
object
2 properties
2 required
State
object
1 property
1 required
serviceType
string
An identifier to refer to partner OP capabilities for application providers.
FederationSupportedAPIs
object
9 properties
5 required
FederationIdentifier
string
Globally unique identifier allocated to an operator platform. This is valid and used only in context of MEC federation interface.
FederationRequestData
object
7 properties
3 required
FederationResponseData
object
8 properties
3 required
FederationContextId
string
This identifier shall be provided by the partner OP on successful verification and validation of the federation create request and is used by partner op to ide…
ProblemDetails
object
4 properties
ServiceEndpoint
object
4 properties
1 required
InvalidParam
object
2 properties
1 required
ZoneDetails
object
3 properties
3 required
ZoneIdentifier
string
Human readable name of the zone.
ZoneRegistrationRequestData
object
2 properties
2 required
ZoneResourceInfo
object
4 properties
ZoneReservationRemoval
object
1 property
ComputeResource
object
4 properties
ZoneFlavour
object
6 properties
OSType
object
4 properties
FixedNetworkIds
array
List of network identifier associated with the fixed line network of the operator platform.
Fqdn
string
Full qualified domain name of an application instance
GpuInfo
object
Information about the supported GPUs
2 properties
2 required
K8sAddons
object
Addons for the Kubernetes cluster. Additional addons should be defined in application the helm chart (Service Mesh, Serverless, AI).
2 properties
K8sNetworking
object
Kubernetes networking definition
2 properties
MobileNetworkIds
object
2 properties
AdditionalStorage
array
Additional storage for the application.
Vcpu
string
Number of vcpus in whole (i.e 1), decimal (i.e 0.500) up to millivcpu, or millivcpu (i.e 500m) format.
KubernetesClusterRef
string
A global unique identifier associated with a Kubernetes cluster infrastructure.
KubernetesResources
object
Definition of Kubernetes Cluster Infrastructure.
7 properties
3 required
VmResources
object
Definition of Virtual Machine Infrastructure
5 properties
3 required
DockerComposeResources
object
Definition of Docker Compose Infrastructure
5 properties
3 required
ContainerResources
object
Container Infrastructure Definition
5 properties
3 required
Ipv4Addr
string
IP of the device. A single IPv4 address may be specified in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
Ipv6Addr
string
IP of the device. A single IPv6 address, following IETF 5952 format, may be specified like 2001:db8:85a3:8d3:1319:8a2e:370:7344
OperatingSystem
object
Information about the Operating System of the application image
4 properties
4 required
Port
integer
Port to stablish the connection
RequiredResources
Fundamental hardware requirements to be provisioned by the Application Provider.
SubmittedApp
object
Information about the submitted app
1 property
serviceAPINames
array
List of Service API capability names an OP supports and offers to other OPs "qualityondemand", "devicelocation" etc.
Uri
string
A Uniform Resource Identifier (URI) as per RFC 3986, identifies the endpoint within an Edge Cloud Zone where the user equipment may connect to the selected app…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ETSI publishes across the network.
