Telstra HealthCheck API
Service health checks for SMS and MMS messaging surfaces.
Telstra HealthCheck API is one of 6 APIs that Telstra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include HealthCheck. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.
This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.2.10.
Requests are made against a single base URL, https://tapi.telstra.com/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Telstra HealthCheck API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 1 scope.
By default, every request must be authenticated.
OAuth2ClientCredentials— OAuth 2.0 client credentials grant against https://tapi.telstra.com/v2/oauth/token with the NSMS scope.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Service health checks for SMS and MMS messaging surfaces.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is HealthCheckResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Telstra 5
Other APIs Telstra publishes across the network.