How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GSMA Application API

Application and Application Instance Lice Cycle Management

GSMA Application API is one of 41 APIs that GSMA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Application. The published artifact set on APIs.io includes an OpenAPI specification, a GitHub repository, API documentation, and an API reference.

This API exposes 11 operations across 6 paths, and defines 65 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: {apiRoot}/{basePath}, {apiRoot}/openGatewayOperateAPIOnboardingAndOrdering/v5/.

11 operations 6 paths 65 schemas 2 DELETE5 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://sandbox.mobilemoneyapi.io/simulator/v1.2/passthrough/mm
Authentication
OpenID Connect
Resource Areas
1

Authentication & Security 1

GSMA Application API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration.

  • openId — OpenID Provider Configuration Information.

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Application 11

Application and Application Instance Lice Cycle Management

POST
/apps
Global System for Mobile Communications Submit application metadata to the Edge…
submitApp 1 param body → 201400401403409500501503
GET
/apps
Global System for Mobile Communications Retrieve a list of existing Applications
getApps 1 param → 200401403404500503
GET
/apps/{appId}
Global System for Mobile Communications Retrieve the information of an…
getApp 2 params → 200401403404500503
DELETE
/apps/{appId}
Global System for Mobile Communications Delete an Application from an Edge…
deleteApp 2 params → 202204400401403404409500
POST
/appinstances
Global System for Mobile Communications Instantiation of an Application
createAppInstance 1 param body → 202400401403409500501503
GET
/appinstances
Global System for Mobile Communications Retrieve the information of Application…
getAppInstance 4 params → 200401403404500503
DELETE
/appinstances/{appInstanceId}
Global System for Mobile Communications Terminate an Application Instance
deleteAppInstance 2 params → 202204400401403404500503
POST
/application
Creates a Application
createApplication 1 param body → 201202400401403404405409
GET
/application
List or find Application objects
listApplication 7 params → 200400401403404405500501
GET
/application/{id}
Retrieves a Application by ID
retrieveApplication 2 params → 200400401403404405500501
PATCH
/application/{id}
Updates partially a Application
patchApplication 2 params body → 200202400401403404405409

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are AppManifest (9 properties), KubernetesResources (7 properties), AppInstanceInfo (5 properties), ContainerResources (5 properties). Each schema is shown below with its type and property counts.

EdgeCloudProvider
string
Human readable name of the Edge Cloud Provider.
KubernetesResources
object
Definition of Kubernetes Cluster Infrastructure.
7 properties 3 required
ErrorInfo
object
Information about the error
3 properties 3 required
SubmittedApp
object
Information about the submitted app
1 property
EdgeCloudZoneName
string
Human readable name of the geographical zone of the Edge Cloud. Defined by the Edge Cloud Provider.
VmResources
object
Definition of Virtual Machine Infrastructure
5 properties 3 required
Fqdn
string
Full qualified domain name of an application instance
RequiredResources
Fundamental hardware requirements to be provisioned by the Application Provider.
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…
K8sAddons
object
Addons for the Kubernetes cluster. Additional addons should be defined in application the helm chart (Service Mesh, Serverless, AI).
2 properties
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
ContainerResources
object
Container Infrastructure Definition
5 properties 3 required
AdditionalStorage
array
Additional storage for the application.
K8sNetworking
object
Kubernetes networking definition
2 properties
AccessEndpoint
object
Application Endpoint for an especific instance that is running in an specific Edge Cloud Zone.
4 properties 1 required
AppInstanceInfo
object
Information about the application instance.
5 properties
AppManifest
object
Application information and requirements provided by the Application Provider
9 properties 7 required
EdgeCloudZoneStatus
string
Status of the Edge Cloud Zone (default is 'unknown')
Port
integer
Port to stablish the connection
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…
GpuInfo
object
Information about the supported GPUs
2 properties 2 required
AppProvider
string
Human readable name of the Application Provider.
KubernetesClusterRef
string
A global unique identifier associated with a Kubernetes cluster infrastructure.
EdgeCloudZoneId
string
Unique identifier created by the Edge Cloud Platform to identify an Edge Cloud Zone within an Edge Cloud.
DockerComposeResources
object
Definition of Docker Compose Infrastructure
5 properties 3 required
AppId
string
A globally unique identifier associated with the application. Edge Cloud Platform generates this identifier when the Application is submitted.
EdgeCloudRegion
string
Human readable name of the geographical Edge Cloud Region of the Edge Cloud. Defined by the Edge Cloud Provider.
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.
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
AppZones
array
Collection of Edge Cloud Zones and/or Kubernetes cluster reference where the Application Provider wants to instantiate the application.
1 required
Vcpu
string
Number of vcpus in whole (i.e 1), decimal (i.e 0.500) up to millivcpu, or millivcpu (i.e 500m) format.
OperatingSystem
object
Information about the Operating System of the application image
4 properties 4 required
ApiPermissionSet
ContactMedium
Extensible
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties 1 required
ApiDigitalIdentity_MVO
ContactMedium_FVO
Application_MVO
ResourceOperationalStateType
string
ResourceOperationalStateType enumerations; values defined by ITU X.731: 'disable': The resource is totally inoperable and unable to provide service to the user…
PartyRoleRef
EntityRef
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties 2 required
Application_FVO
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
ApiDigitalIdentity
AssetGroup
object
Defines a group of assets (entities) to which access can be controlled. Specific subclasses allow definition in various ways (list of entities, queries, owners…
Application
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
ExternalIdentifier
ApiConsumerPermission
OAuth2ClientCredential
LogicalResource
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
ExternalIdentifier_FVO
ApiListAssetGroup
Addressable
object
Base schema for addressable entities
2 properties
ApplicationCategoryType
string
Valid values for the category of the Application. Please refer to main Application stores in order to retrieve a more precise definition of the categories.
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ProductRef
object
A Product reference
ApprovalStatusType
string
Valid values for an ApprovalStatus in the context of an approval process.
LogicalResource_MVO
LogicalResource_FVO
ApiDigitalIdentity_FVO
Application_RES
object
Response object for Application
2 required
LogicalResourceRole
object
A logical Resource Role is a role given to a logical resource in a given context.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gsma-application-api-openapi.yml Raw ↑

Other APIs GSMA publishes across the network.

GSMA Accounts API
GSMA Authorisation Codes API
GSMA Bills API
GSMA Call Forwarding information retrieval API
GSMA Check Device Swap API
GSMA Debit Mandates API
GSMA Discovery API
GSMA Home Devices QoD API
GSMA Links API
GSMA Location Retrieval API
GSMA Match API
GSMA One Step Payment API
Where this information came from

This is an independent, third-party profile of GSMA Application API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.