Newer
Older
description: The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
contact:
email: cti_support@etsi.org
description: 'ETSI GS MEC011 Application Enablement API, V3.1.1'
url: >-
https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/03.01.01_60/gs_MEC011v030101p.pdf
- name: appTrafficRules
- name: appDnsRules
- name: appSubscriptions
- name: appConfirmTermination
- name: appConfirmReady
- name: timing
- name: callbacks
- name: appRegistrations
jsonSchemaDialect: 'https://json-schema.org/draft/2020-12/schema'
- url: 'http://127.0.0.1:8081/mec_app_support/v2'
variables: {}
- url: 'https://127.0.0.1:8081/mec_app_support/v2'
variables: {}
'/applications/{appInstanceId}/traffic_rules':
- appTrafficRules
summary: get traffic rules
description: >-
This method retrieves information about all the traffic rules associated
with a MEC application instance.
operationId: ApplicationsTrafficRules_GET
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
description: >-
Upon success, a response message content containing an array of the
TrafficRules is returned.
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TrafficRule'
description: ''
examples:
- - trafficRuleId: TrafficRule123
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.100/32
- 192.127.4.101/32
dstAddress:
- 192.127.4.102/32
- 192.127.4.103/32
srcPort:
- '80'
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
- dstInterface: null
interfaceType: IP
tunnelInfo: tunnel
dstIpAddress: 20.1.1.1
state: ACTIVE
contentMediaType: application/json
examples:
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.100/32
- 192.127.4.101/32
dstAddress:
- 192.127.4.102/32
- 192.127.4.103/32
srcPort:
- '80'
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
dstIpAddress: 20.1.1.1
state: ACTIVE
- trafficRuleId: TrafficRule123
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.104/32
- 192.127.4.105/32
dstAddress:
- 192.127.4.106/32
- 192.127.4.107/32
srcPort:
- '80'
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
- dstInterface: null
interfaceType: IP
tunnelInfo: tunnel
dstIpAddress: 20.1.1.2
state: ACTIVE
description: >-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
'/applications/{appInstanceId}/traffic_rules/{trafficRuleId}':
- appTrafficRules
summary: Get traffic rule
description: >-
This method retrieves information about all the traffic rules associated
with a MEC application instance.
operationId: ApplicationsTrafficRule_GET
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: trafficRuleId
in: path
description: Represents a traffic rule.
required: true
style: simple
schema:
type: string
description: >-
Upon success, a response message content containing the TrafficRules
is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
examples:
trafficRuleId: TrafficRule123
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.100/32
- 192.127.4.101/32
dstAddress:
- 192.127.4.102/32
- 192.127.4.103/32
srcPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
description: >-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
- appTrafficRules
summary: Update traffic rule
description: >-
This method retrieves information about all the traffic rules associated
with a MEC application instance.
operationId: ApplicationsTrafficRule_PUT
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: trafficRuleId
in: path
description: Represents a traffic rule.
required: true
style: simple
schema:
type: string
description: >-
One or more updated attributes that are allowed to be changed are
included in the TrafficRule data structure in the message content of
the request.
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
required: true
description: >-
Upon success, a response message content containing data type
describing the updated TrafficRule is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
examples:
trafficRuleId: TrafficRule123
serName: ExampleService
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.127.4.100/32
- 192.127.4.101/32
dstAddress:
- 192.127.4.102/32
- 192.127.4.103/32
srcPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
description: >-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Precondition Failed. It is used when a condition has failed during
conditional requests, e.g. when using ETags to avoid write
conflicts.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
'/applications/{appInstanceId}/dns_rules':
- appDnsRules
summary: Get DNS rules
description: >-
This method retrieves information about all the DNS rules associated
with a MEC application instance.
operationId: ApplicationsDnsRules_GET
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
description: >-
Upon success, a response message content containing an array of the
DnsRules is returned.
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DnsRule'
description: ''
examples:
- - dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
- dnsRuleId: DnsRule2
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.4
ttl: 300
state: INACTIVE
contentMediaType: application/json
examples:
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
- dnsRuleId: DnsRule2
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.4
ttl: 300
state: INACTIVE
description: >-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
'/applications/{appInstanceId}/dns_rules/{dnsRuleId}':
- appDnsRules
summary: Get DNS rule
description: >-
This method retrieves information about a DNS rule associated with a MEC
application instance.
operationId: ApplicationsDnsRule_GET
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: dnsRuleId
in: path
description: Represents a DNS rule.
required: true
style: simple
schema:
type: string
description: >-
Upon success, a response message content containing the DnsRules is
returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
examples:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
description: >-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
- appDnsRules
summary: Update DNS rule
description: 'This method activates, de-activates or updates a traffic rule.'
operationId: ApplicationsDnsRule_PUT
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: dnsRuleId
in: path
description: Represents a DNS rule.
required: true
style: simple
schema:
type: string
description: The updated "state" is included in the message content of the request.
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
required: true
description: >-
Upon success, a response message content containing data type
describing the updated DnsRule is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
examples:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
description: >-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Precondition Failed. It is used when a condition has failed during
conditional requests, e.g. when using ETags to avoid write
conflicts.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
'/applications/{appInstanceId}/subscriptions':
- appSubscriptions
summary: Get subscriptions
description: >-
The GET method may be used to request information about all
subscriptions for this requestor. Upon success, the response contains
message content with all the subscriptions for the requestor.
operationId: ApplicationsSubscriptions_GET
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
description: >-
Upon success, a response message content containing the list of
links to the requested subscriptions is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList'
description: >-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
- appSubscriptions
summary: Create subscription
description: >-
The POST method may be used to create a new subscription. One example
use case is to create a new subscription to the MEC service availability
notifications. Upon success, the response contains message content
describing the created subscription.
operationId: ApplicationsSubscriptions_POST
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
description: >-
Message content in the request contains a subscription to the MEC
application termination notifications that is to be created.
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotificationSubscription'
required: true
description: >-
Entity body in the request contains a subscription to the MEC
service availability notifications that is to be created.
headers:
location:
description: The resource URI of the created resource
content:
text/plain:
schema:
type: string
description: The resource URI of the created resource
contentMediaType: text/plain
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotificationSubscription'
description: >-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
callbacks:
AppTerminationNotification:
'{$request.body#/callbackUri}':
post:
description: >-
Represents the information that the MEP notifies the subscribed
application instance about the corresponding application
instance termination/stop'
operationId: AppTerminationNotification_POST
tags:
- callbacks
summary: Create callback
$ref: '#/components/requestBodies/AppTerminationNotification'
responses:
'200':
description: >-
Expected responses from callback consumer, if it accepts the
callback
'/applications/{appInstanceId}/subscriptions/{subscriptionId}':
- appSubscriptions
summary: Get subscription
description: >-
The GET method requests information about a subscription for this
requestor. Upon success, the response contains message content with the
subscription for the requestor.
operationId: ApplicationsSubscription_GET
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: subscriptionId
in: path
description: >-
Represents a subscription to the notifications from the MEC
platform.
required: true
style: simple
schema:
type: string
description: >-
Upon success, a response message content containing the requested
subscription is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotificationSubscription'
description: >-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
- appSubscriptions
summary: delete subscription
description: >-
This method deletes a mecAppSuptApiSubscription. This method is
typically used in "Unsubscribing from service availability event
notifications" procedure.
operationId: ApplicationsSubscription_DELETE
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: subscriptionId
in: path
description: >-
Represents a subscription to the notifications from the MEC
platform.
required: true
style: simple
schema:
type: string
responses:
'204':
description: No Content
description: >-
Forbidden. The operation is not allowed given the current status of
the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: >-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
'/applications/{appInstanceId}/confirm_termination':
- appConfirmTermination
summary: Confirm termination
description: >-
This method is used to confirm the application level termination of an
application instance.
operationId: ApplicationsConfirmTermination_POST
parameters:
- name: appInstanceId
in: path
description: >-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.