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

3GPP Individual APF published API (Document) API

The Individual APF published API (Document) API from 3GPP — 1 operation(s) for individual apf published api (document).

3GPP Individual APF published API (Document) API is one of 194 APIs that 3GPP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Individual APF published API (Document). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 1 path, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.4.0.

Requests are made against a single base URL, {apiRoot}/published-apis/v1.

4 operations 1 paths 18 schemas 1 DELETE1 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.4.0
Base URL
{notificationRecipientAddress}
Resource Areas
1

Paths & Operations 4

Across 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Individual APF published API (Document) 4
GET
/{apfId}/service-apis/{serviceApiId}
Retrieve a published service API.
GetIndAPFPubAPI 2 params → 200307308400401403404406
PUT
/{apfId}/service-apis/{serviceApiId}
Update a published service API.
UpdateIndAPFPubAPI 2 params body → 200204307308400401403404
PATCH
/{apfId}/service-apis/{serviceApiId}
Modify an existing published service API.
ModifyIndAPFPubAPI 2 params body → 200204307308400401403404
DELETE
/{apfId}/service-apis/{serviceApiId}
Unpublish a published service API.
DeleteIndAPFPubAPI 2 params → 204307308400401403404429

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ServiceAPIDescription (13 properties), AefProfile (11 properties), ServiceKpis (8 properties), ServiceAPIDescriptionPatch (8 properties). Each schema is shown below with its type and property counts.

CommunicationType
Indicates a communication type of the resource or the custom operation. Possible values are: - REQUESTRESPONSE: The communication is of the type request-respon…
DataFormat
Indicates a data format. Possible values are: - JSON: Indicates that the data format is JSON. - XML: Indicates that the data format is Extensible Markup Langua…
InterfaceDescription
object
Represents the description of an API's interface.
7 properties
ServiceAPIDescriptionPatch
object
Represents the parameters to request the modification of an APF published API resource.
8 properties
AefProfile
object
Represents the AEF profile data.
11 properties 2 required
ApiStatus
object
Represents the API status.
1 property 1 required
ShareableInformation
object
Indicates whether the service API and/or the service API category can be shared to the list of CAPIF provider domains.
2 properties 1 required
IpAddrRange
object
Represents the list of public IP ranges
2 properties
AefLocation
object
Represents the location information (e.g. civic address, GPS coordinates, data center ID) where the AEF providing the service API is located.
3 properties
Operation
Indicates an HTTP method. Possible values are: - GET: HTTP GET method. - POST: HTTP POST method. - PUT: HTTP PUT method. - PATCH: HTTP PATCH method. - DELETE:…
SecurityMethod
Indicates the security method. Possible values are: - PSK: Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122. - PKI: Security method 2 (Using PK…
Resource
object
Represents the API resource data.
7 properties 3 required
CustomOperation
object
Represents the description of a custom operation.
4 properties 2 required
ServiceKpis
object
Represents information about the service characteristics provided by a service API.
8 properties
ServiceAPIDescription
object
Represents the description of a service API as published by the APF.
13 properties 1 required
Protocol
Indicates a protocol and protocol version used by the API. Possible values are: - HTTP11: Indicates that the protocol is HTTP version 1.1. - HTTP2: Indicates t…
PublishedApiPath
object
Represents the published API path within the same CAPIF provider domain.
1 property
Version
object
Represents the API version information.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

3gpp-individual-apf-published-api-document-api-openapi.yml Raw ↑

Other APIs 3GPP publishes across the network.

3GPP Forge API
3GPP 3gpp Nidd Configuration Trigger API
3GPP 5GLAN Parameters Provision Subscriptions API
3GPP Access Control Policy List (Collection) API
3GPP ACS Configuration Subscriptions API
3GPP Activation Management API
3GPP Addressing Parameters Provisionings (Collection) API
3GPP AF level UE location update notification operation API
3GPP AIoT Command Request (custom operation without associated resources) API
3GPP AIoT Inventory Request (custom operation without associated resources) API
3GPP All API Provider Domains Registrations (Collection) API
3GPP All published service APIs (Collection) API
Where this information came from

This is an independent, third-party profile of 3GPP Individual APF published API (Document) 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.