Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nevercode Over-the-air Updates API

REST API endpoints for over-the-air updates.

Nevercode Over-the-air Updates API is one of 13 APIs that Nevercode publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Over-the-air Updates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 15 operations across 14 paths, and defines 31 schemas. It is described by OpenAPI 3.1.0, at version v3.0.

Requests are made against a single base URL, https://codemagic.io/.

15 operations 14 paths 31 schemas 1 DELETE13 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3.0
Base URL
https://codemagic.io/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Nevercode Over-the-air Updates API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-auth-token (api_key). By default, every request must be authenticated.

Paths & Operations 15

Across 14 paths, the API surfaces 15 operations — 1 DELETE, 13 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Over-the-air Updates 15

REST API endpoints for over-the-air updates.

GET
/api/v3/over-the-air-updates
Get account information for the authenticated user
ApiV3OverTheAirUpdatesGetAccountInfo → 200
GET
/api/v3/ota
Get account information for the authenticated user
ApiV3OtaGetAccountInfo → 200
GET
/api/v3/over-the-air-updates/deployments/{deployment_id}/releases
Get deployment releases history
ApiV3OverTheAirUpdatesDeploymentsDeploymentIdReleasesListDeploymentReleases 3 params → 200400
GET
/api/v3/ota/deployments/{deployment_id}/releases
Get deployment releases history
ApiV3OtaDeploymentsDeploymentIdReleasesListDeploymentReleases 3 params → 200400
GET
/api/v3/over-the-air-updates/projects/{project_id}/deployment-keys
Get project deployment keys
ApiV3OverTheAirUpdatesProjectsProjectIdDeploymentKeysListDeploymentKeys 3 params → 200400
GET
/api/v3/ota/projects/{project_id}/deployment-keys
Get project deployment keys
ApiV3OtaProjectsProjectIdDeploymentKeysListDeploymentKeys 3 params → 200400
GET
/api/v3/ota/deployments/{deployment_id}/usage/{metric}
Get usage stats for a deployment channel.
ApiV3OtaDeploymentsDeploymentIdUsageMetricGetDeploymentUsage 4 params → 200400
GET
/api/v3/over-the-air-updates/deployments/{deployment_id}/usage/{metric}
Get usage stats for a deployment channel.
ApiV3OverTheAirUpdatesDeploymentsDeploymentIdUsageMetricGetDeploymentUsage 4 params → 200400
GET
/api/v3/ota/{team_id}/access-keys
List all access keys for a team
ApiV3OtaTeamIdAccessKeysListOtaAccessKeys 3 params → 200400
POST
/api/v3/ota/{team_id}/access-keys
Create an access key for a team
ApiV3OtaTeamIdAccessKeysCreateOtaAccessKey 1 param body → 201400
DELETE
/api/v3/ota/{team_id}/access-keys/{key_id}
Delete an access key for a team
ApiV3OtaTeamIdAccessKeysKeyIdDeleteOtaAccessKey 2 params → 204400
GET
/api/v3/ota/{team_id}/projects
List projects for the team
ApiV3OtaTeamIdProjectsListProjects 3 params → 200400
GET
/api/v3/over-the-air-updates/{team_id}/projects
List projects for the team
ApiV3OverTheAirUpdatesTeamIdProjectsListProjects 3 params → 200400
GET
/api/v3/over-the-air-updates/{team_id}/usage
Get usage stats for the team.
ApiV3OverTheAirUpdatesTeamIdUsageGetUsage 3 params → 200400
GET
/api/v3/ota/{team_id}/usage
Get usage stats for the team.
ApiV3OtaTeamIdUsageGetUsage 3 params → 200400

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are ProjectUpdateSchema (6 properties), CreatedAccessKeySchema (6 properties), AccessKeySchema (5 properties), DeploymentReleaseSchema (5 properties). Each schema is shown below with its type and property counts.

DeploymentReleaseStatus
string
ClassicPagination_api.routes.ota_deployment_releases.schemas.DeploymentReleaseSchema_
object
4 properties 4 required
ota_deployment_releases_schemas_MetricSchema
object
2 properties 2 required
ProjectUpdateSchema
object
6 properties 6 required
ota_team_usage_schemas_UsageSchema
object
3 properties 3 required
ClassicPagination_api.routes.ota_project_deployment_keys.schemas.DeploymentKeySchema_
object
4 properties 4 required
ota_team_usage_schemas_ValueSchema
object
2 properties 2 required
ClassicPagination_api.routes.ota_team_access_keys.schemas.AccessKeySchema_
object
4 properties 4 required
ClassicPagination_api.routes.ota_team_projects.schemas.ProjectSchema_
object
4 properties 4 required
ota_team_projects_schemas_MetricSchema
object
2 properties 2 required
NoPagination_api.routes.ota_deployment_usage.schemas.UsageSchema_
object
1 property 1 required
NoPagination_api.routes.ota_team_usage.schemas.UsageSchema_
object
1 property 1 required
AccountSchema
object
2 properties 1 required
MetricType
string
The name of the usage metric to retrieve.
DeploymentChannelSchema
object
2 properties 2 required
ota_deployment_usage_schemas_MetaSchema
object
3 properties 3 required
ota_team_usage_schemas_SeriesSchema
object
3 properties 3 required
CreatedAccessKeySchema
object
6 properties 6 required
ota_deployment_usage_schemas_SeriesSchema
object
3 properties 3 required
ota_team_usage_schemas_MetaSchema
object
3 properties 3 required
ota_deployment_usage_schemas_ValueSchema
object
2 properties 2 required
DeploymentReleaseSchema
object
5 properties 2 required
ota_deployment_usage_schemas_UsageSchema
object
2 properties 2 required
NoPagination_api.routes.ota_team_access_keys.schemas.CreatedAccessKeySchema_
object
1 property 1 required
SummarySchema
object
2 properties 2 required
ProjectSchema
object
4 properties 3 required
DeploymentKeySchema
object
2 properties 2 required
NoPagination_api.routes.ota.schemas.AccountSchema_
object
1 property 1 required
CreateAccessKeySchema
object
2 properties 1 required
AccessKeySchema
object
5 properties 5 required
Status
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nevercode-over-the-air-updates-api-openapi.yml Raw ↑

Other APIs Nevercode publishes across the network.

Nevercode App Previews API
Nevercode Applications API
Nevercode Billing API
Nevercode Build Dashboards API
Nevercode Builds API
Nevercode Meta API
Nevercode Secrets and Environment Vars API
Nevercode Team Invitations API
Nevercode Team Members API
Nevercode Teams API
Nevercode Tester Groups API
Nevercode Users API