Get a list of all applications for a project.

GET 
/api/admin/projects/:projectId/applications

This endpoint returns an list of all the applications for a project.

Request

Path Parameters

projectId stringrequired

Query Parameters

query string

The search query for the application name, sdk, environment

offset string

The number of applications to skip when returning a page. By default it is set to 0.

limit string

The number of applications to return in a page. By default it is set to 50.

sortBy string

The field to sort the results by. By default it is set to "appName".

sortOrder string

The sort order for the sortBy. By default it is det to "asc".

Responses

200

projectApplicationsSchema

application/json

Schema

Schema

total integerrequired
The total number of project applications.
Example: 50

applications

object[]

required

All applications defined for a specific project.

Array [

name stringrequired

Name of the application that is using the SDK. This is the same as the appName in the SDK configuration.

environments string[]required

The environments that the application is using. This is the same as the environment in the SDK configuration.

Example: ["development","production"]

instances string[]required

The instances of the application that are using the SDK.

Example: ["prod-b4ca","prod-ac8a"]

sdks

object[]

required

The SDKs that the application is using.

Array [

name stringrequired

Name of the SDK package that the application is using.

Example: unleash-client-node

versions string[]required

The versions of the SDK that the application is using.

Example: ["4.1.1"]

]

]

Example (from schema)

{
  "total": 50,
  "applications": [
    {
      "name": "string",
      "environments": [
        "development",
        "production"
      ],
      "instances": [
        "prod-b4ca",
        "prod-ac8a"
      ],
      "sdks": [
        {
          "name": "unleash-client-node",
          "versions": [
            "4.1.1"
          ]
        }
      ]
    }
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NotFoundError
message string
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...