Get an application

GET 
/api/v1/applications/:appId

Retrieve details of a specific application within an organization

Request

Path Parameters

appId stringrequired

Application Id

Header Parameters

X-API-KEY stringrequired

APIKey

Responses

200

Detailed information about the application

application/json

Schema

Schema

data

object

appName string

appName is the name of the application.

appProfileName string

appProfileName is the name of the application profile.

endpoint string

endpoint is the endpoint of the application.

id string

id is the unique identifier of the application.

namespace string

namespace is the namespace where platform creates the application.

orgId string

orgId is the organization ID where the application is created.

slug string

slug is the unique identifier of the application.

status string

status is the status of the application.

targetNamespace string

targetNamespace is the target namespace where the application is deployed.

id string
message string
status string

Example (from schema)

{
  "data": {
    "appName": "string",
    "appProfileName": "string",
    "endpoint": "string",
    "id": "string",
    "namespace": "string",
    "orgId": "string",
    "slug": "string",
    "status": "string",
    "targetNamespace": "string"
  },
  "id": "string",
  "message": "string",
  "status": "string"
}

404

application not found

application/json

Schema

Schema

error string
error_code string

Example (from schema)

{
  "error": "string",
  "error_code": "string"
}

500

Unable to fetch application

application/json

Schema

Schema

error string
error_code string

Example (from schema)

{
  "error": "string",
  "error_code": "string"
}

Loading...