You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
.option("--token <token>","Bearer token for authentication")
127
127
.description(`
128
-
Create application request operation:
128
+
Create a new application inside an organisation. Pass the target organisation in the x-organisation header. Returns the created application and the caller's access levels. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
200
200
.description(`
201
-
Create dimension request operation:
201
+
Create a targeting dimension (standard or cohort) that releases can be targeted against. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
292
292
.description(`
293
-
Create file request operation:
293
+
Register a file by URL, recording its metadata and assigning it a version. Pass the organisation and application in the x-organisation and x-application headers. Use this when the file is already hosted somewhere the server can reach; to upload the bytes directly, use UploadFile instead. Requires a bearer token.:
294
294
295
295
Usage 1 - Individual options:
296
296
$ airborne-core-cli CreateFile \\
@@ -369,7 +369,7 @@ program
369
369
.option("--name <name>","name parameter")
370
370
.option("--token <token>","Bearer token for authentication")
371
371
.description(`
372
-
Create organisation request operation:
372
+
Create a new organisation owned by the authenticated user. Returns the created organisation with its (initially empty) application list and the caller's access levels. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
433
433
.description(`
434
-
Create package request operation:
434
+
Create a package: an index file plus the set of files that make up an OTA bundle. Pass the organisation and application in the x-organisation and x-application headers. Returns the created package with its assigned version. Requires a bearer token.:
435
435
436
436
Usage 1 - Individual options:
437
437
$ airborne-core-cli CreatePackage \\
@@ -450,7 +450,7 @@ Usage 3 - Mixed Usage:
450
450
451
451
Parameters:
452
452
--index <string> (required) : Index file id
453
-
--tag <string> (optional)
453
+
--tag <string> (optional) : Optional tag to identify the package.
454
454
--files [<string>] (required) : Space Separated file ids to be included in the package
455
455
--organisation <string> (required) : Name of the organisation
456
456
--application <string> (required) : Name of the application
.option("--token <token>","Bearer token for authentication")
513
513
.description(`
514
-
Create release request operation:
514
+
Create a new release. A release points a package (and any resources) at a set of targeting dimensions; ramp it later to roll it out. Pass the organisation and application in the x-organisation and x-application headers. Returns the created release with its resolved config and package. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
667
667
.description(`
668
-
Release request operation:
668
+
Get a single release by its id, including its config, package, resources, targeting dimensions, and experiment details. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
669
669
670
670
Usage 1 - Individual options:
671
671
$ airborne-core-cli GetRelease \\
@@ -731,7 +731,7 @@ program
731
731
732
732
.option("--token <token>","Bearer token for authentication")
733
733
.description(`
734
-
Get user request operation:
734
+
Get the authenticated user's profile, including the organisations they belong to and the caller's access level in each. Requires a bearer token.:
735
735
736
736
Usage 1 - Individual options:
737
737
$ airborne-core-cli GetUser \\
@@ -800,7 +800,7 @@ program
800
800
})
801
801
.option("--token <token>","Bearer token for authentication")
802
802
.description(`
803
-
List dimensions request operation:
803
+
List the targeting dimensions defined for an application, in priority order, with pagination. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
804
804
805
805
Usage 1 - Individual options:
806
806
$ airborne-core-cli ListDimensions \\
@@ -818,8 +818,8 @@ Usage 3 - Mixed Usage:
818
818
Parameters:
819
819
--organisation <string> (required) : Name of the organisation
820
820
--application <string> (required) : Name of the application
821
-
--page <integer> (optional)
822
-
--count <integer> (optional)
821
+
--page <integer> (optional) : Page number for pagination.
822
+
--count <integer> (optional) : Number of dimensions per page.
823
823
--token <string> (required) : Bearer token for authentication
.option("--token <token>","Bearer token for authentication")
887
887
.description(`
888
-
List file groups operation:
888
+
List files grouped by path, so that all versions and tags of a file appear together. Supports pagination and optional search and tag filters. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
976
976
.description(`
977
-
List files request operation:
977
+
List files for an application, with pagination and optional search and tag filters. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
978
978
979
979
Usage 1 - Individual options:
980
980
$ airborne-core-cli ListFiles \\
@@ -1046,7 +1046,7 @@ program
1046
1046
1047
1047
.option("--token <token>","Bearer token for authentication")
1048
1048
.description(`
1049
-
List organisations request operation:
1049
+
List all organisations the authenticated user belongs to, along with their applications and the caller's access level in each. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
1123
1123
.description(`
1124
-
List packages request operation:
1124
+
List packages for an application, with pagination and optional search by index file path. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
1217
1217
.description(`
1218
-
List Releases request operation:
1218
+
List releases for an application, with pagination and optional filtering by status or targeting dimension. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
Exchange user credentials (client_id and client_secret) for an access token and a refresh token. Public — no auth token required. Call this first, then send the returned access token as a bearer token on subsequent requests.:
.option("--token <token>","Bearer token for authentication")
1354
1354
.description(`
1355
-
Request organisation request operation:
1355
+
Submit a request to have an organisation provisioned (for onboarding flows that require manual approval), including contact details and store links. Returns a confirmation message. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
1433
1433
.description(`
1434
-
Get release request operation:
1434
+
Resolve and return the active release configuration for an application, given the caller's targeting dimensions. This is the endpoint the SDK calls at boot. Public — no auth token required.:
.option("--token <token>","Bearer token for authentication")
1496
1496
.description(`
1497
-
Get release v2 request operation:
1497
+
Version 2 of the release-resolution endpoint: resolves and returns the active release configuration for an application based on the caller's targeting dimensions. This is the endpoint newer SDKs call at boot. Public — no auth token required.:
.option("--token <token>","Bearer token for authentication")
1568
1568
.description(`
1569
-
Update dimension request operation:
1569
+
Update a dimension, identified by name in the path — for example to change its priority position. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
1645
1645
.description(`
1646
-
Update file operation:
1646
+
Update the tag of an existing file, identified by its file key in the path (a file path with a version or tag, e.g. "path/to/file@version:3" or "path/to/file@tag:prod"). Pass the organisation and application in the x-organisation and x-application headers. Returns the updated file. Requires a bearer token.:
.option("--token <token>","Bearer token for authentication")
1729
1729
.description(`
1730
-
Upload filerequest operation:
1730
+
Upload a file's bytes directly as the request body and register it in one step. Send the raw file as the payload, with its Base64-encoded SHA-256 digest in the x-checksum header and the organisation and application in the x-organisation and x-application headers. Returns the created file. Requires a bearer token.:
* Create a new application inside an organisation. Pass the target organisation in the x-organisation header. Returns the created application and the caller's access levels. Requires a bearer token.
31
31
* @example
32
32
* Use a bare-bones client and the command you need to make an API call.
* Create a targeting dimension (standard or cohort) that releases can be targeted against. Pass the organisation and application in the x-organisation and x-application headers. Requires a bearer token.
31
31
* @example
32
32
* Use a bare-bones client and the command you need to make an API call.
* Register a file by URL, recording its metadata and assigning it a version. Pass the organisation and application in the x-organisation and x-application headers. Use this when the file is already hosted somewhere the server can reach; to upload the bytes directly, use UploadFile instead. Requires a bearer token.
31
31
* @example
32
32
* Use a bare-bones client and the command you need to make an API call.
* Create a new organisation owned by the authenticated user. Returns the created organisation with its (initially empty) application list and the caller's access levels. Requires a bearer token.
31
31
* @example
32
32
* Use a bare-bones client and the command you need to make an API call.
* Create a package: an index file plus the set of files that make up an OTA bundle. Pass the organisation and application in the x-organisation and x-application headers. Returns the created package with its assigned version. Requires a bearer token.
31
31
* @example
32
32
* Use a bare-bones client and the command you need to make an API call.
* Create a new release. A release points a package (and any resources) at a set of targeting dimensions; ramp it later to roll it out. Pass the organisation and application in the x-organisation and x-application headers. Returns the created release with its resolved config and package. Requires a bearer token.
31
31
* @example
32
32
* Use a bare-bones client and the command you need to make an API call.
0 commit comments