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 App Previews API

REST API endpoints for app previews.

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

Tagged areas include App Previews. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 5 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version v3.0.

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

6 operations 5 paths 21 schemas 1 DELETE3 GET2 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 App Previews 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 6

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

App Previews 6

REST API endpoints for app previews.

POST
/api/v3/builds/{build_id}/preview
Start an app preview
ApiV3BuildsBuildIdPreviewStartPreview 1 param body → 201402400
GET
/api/v3/teams/{team_id}/previews
List app previews for the team
ApiV3TeamsTeamIdPreviewsListTeamPreviews 3 params → 200400
GET
/api/v3/previews/{preview_id}
Get app preview information
ApiV3PreviewsPreviewIdGetPreviewInformation 1 param → 200400
DELETE
/api/v3/previews/{preview_id}
Stop an app preview
ApiV3PreviewsPreviewIdStopPreview 1 param → 204400
POST
/api/v3/previews/{preview_id}/share
Share an app preview
ApiV3PreviewsPreviewIdShareSharePreview 1 param → 201400
GET
/api/v3/shared-previews/{shared_preview_id}
Get shared app preview information
ApiV3SharedPreviewsSharedPreviewIdGetSharedPreview 1 param → 200400

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are team_previews_schemas_AppPreviewSchema (8 properties), previews_schemas_AppPreviewSchema (8 properties), ClassicPagination_api.routes.team_previews.schemas.AppPreviewSchema_ (4 properties), previews_schemas_ArtifactSchema (4 properties). Each schema is shown below with its type and property counts.

StartPreviewSchema
object
1 property 1 required
PaymentRequiredSchema
object
3 properties 3 required
SharedAppPreviewDetailsSchema
object
3 properties 3 required
team_previews_schemas_AppPreviewSchema
object
8 properties 7 required
StartedAppPreviewSchema
object
2 properties 2 required
team_previews_schemas_ReleaseNoteSchema
object
2 properties 2 required
NoPagination_api.routes.shared_previews.schemas.SharedAppPreviewDetailsSchema_
object
1 property 1 required
team_previews_schemas_BuildSchema
object
3 properties 3 required
NoPagination_api.routes.previews.schemas.AppPreviewSchema_
object
1 property 1 required
NoPagination_api.routes.previews.schemas.SharedAppPreviewSchema_
object
1 property 1 required
NoPagination_api.routes.builds.schemas.StartedAppPreviewSchema_
object
1 property 1 required
previews_schemas_ArtifactSchema
object
4 properties 2 required
ExtraSchema
object
1 property 1 required
SharedAppPreviewSchema
object
2 properties 2 required
AppPreviewApplicationSchema
object
3 properties 2 required
team_previews_schemas_ArtifactSchema
object
4 properties 2 required
previews_schemas_ReleaseNoteSchema
object
2 properties 2 required
previews_schemas_BuildSchema
object
3 properties 3 required
previews_schemas_AppSchema
object
3 properties 2 required
previews_schemas_AppPreviewSchema
object
8 properties 7 required
ClassicPagination_api.routes.team_previews.schemas.AppPreviewSchema_
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nevercode-app-previews-api-openapi.yml Raw ↑

Other APIs Nevercode publishes across the network.

Nevercode Applications API
Nevercode Billing API
Nevercode Build Dashboards API
Nevercode Builds API
Nevercode Meta API
Nevercode Over-the-air Updates 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