Sign in

v5

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-0330110112.1 KB
Applications

Get one Application

Get an Application using HRID

get/organizations/{orgId}/environments/{envId}/applications/{hrid}

Path parameters

orgIdstring required
Example:dedd0e0f-b3e9-4d2f-89cd-b2a9de7cb145

organization ID

envIdstring required
Example:a44e0d1b-9fa9-4d64-8b76-3634623a2e27

environment ID

hridstring required
Example:my_demo_api

Human-readable ID of a spec

Response

Application successfully retrieved

hridstring required

A unique human readable id identifying this resource

namestring required

Application's name. Duplicate names can exists.

descriptionstring required

This is where you can clearly state the API’s purpose and what problems it solves to help drive API discovery and adoption by making it easier for developers to find and understand the API’s capabilities.

domainstring

Application's domain.

groupsstring[]

List of groups associated with the Application. This groups are names, HRIDs or UUIDs of existing groups in APIM.

pictureUrlstring

Application's picture Url.

notifyMembersboolean

If true, new members added to the Application spec will be notified when the Application is synced with APIM.

backgroundstring

Application's background url

status'ACTIVE' | 'ARCHIVED'

Application are either ACTIVE or ARCHIVED never actually deleted.

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

Example response

{
  "hrid": "demo_api",
  "name": "Example Application",
  "description": "This is the documentation explaining purpose of this Application.",
  "domain": "examples.com",
  "groups": [
    "developers"
  ],
  "pictureUrl": "https://upload.wikimedia.org/wikipedia/fr/0/09/Logo_App_Store_d%27Apple.png",
  "background": "https://upload.wikimedia.org/wikipedia/commons/d/df/Green_Red_Gradient_Background.png",
  "primaryOwner": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "email": "john.doe@example.com",
    "displayName": "John Doe",
    "type": "USER"
  },
  "settings": {
    "app": {
      "type": "web",
      "clientId": "example-client-id"
    },
    "oauth": {
      "applicationType": "browser",
      "grantTypes": [
        "authorization_code"
      ],
      "redirectUris": [
        "https://myapp.example.com/oauth/callback"
      ]
    },
    "tls": {
      "clientCertificate": "-----BEGIN CERTIFICATE-----\nMIIDfjCCAmagAwIBAgIUfHj3mygGaOfd1u1Uj09L6vY5stcwDQYJKoZIhvcNAQEL\nBQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM\nGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yNTA4MDUxNTUyMTBaFw0yNjA4\nMDUxNTUyMTBaMGkxCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UE\nBwwEQ2l0eTEVMBMGA1UECgwMT3JnYW5pemF0aW9uMRMwEQYDVQQLDApEZXBhcnRt\nZW50MQ8wDQYDVQQDDAZjbGllbnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDW862KHvjkq0EtwZJO/xw+QoTnRB0qm4E5+1wspC1er6tOm3hTJqCzfKwQ\ngZQKoP1Eq1PhM8GzceeqGjh8VZJaDmWwiJZdk5fprrZ1Lvwwl010lnh4MEhtN0Dw\nlwHSZCQ/vSvEDWJXugiE4F1OvAgi2+lIR5uYfyy2U6YbhlcVPdGAboBAFSQnxECF\n1gDpc3dFarPXfO/X3yf/BzAHys6IyMyqvBbur3K2UTO4gJL+59/DEyAwx7ofwukj\nTWpgGNDXlNFYwKk9qTSTbxdcofAVCjrBCEDTdoPkvrr5SxI7dV/ha5y33iOI4VPV\no6vN/58RJz+ZMI0mbOBeluqBW+xBAgMBAAGjQjBAMB0GA1UdDgQWBBTjpQ+KfcmK\nw4hCptY8iK/LX9BOhzAfBgNVHSMEGDAWgBQYdcUWurMS8FEEMzcJlFm2d4Dk3DAN\nBgkqhkiG9w0BAQsFAAOCAQEAoyv0RhgEbRNmyFF6WoTeH4durjmZRe3SCtum0Mnv\n4TOGT4sstPdz0l24psroL33z3jtsY8IrbqnSfTXWbziSCanDXnMHOewLykgN0ld0\nPHa2i5naU5tMeGdWeM80ZTXU7GMiiCkgrRai/V7GkXNKYTIdBontiLpbxUaGLpjY\naMYoCmHIEizazQP9xaAtm40CkYub1o40kgyQULyrwftqrlRtKshfYmHB6yxYVz60\npikgTVupVbhYcNMLOVXO7Q31UEYfC7fxMGqzybXg67EhvzoykXhhYo3YqAjho2yh\num2oEO8b5eQVAwRaooVLh0uqjZCpfN2ozscPpiTM9Pj3xQ==\n-----END CERTIFICATE-----\n"
    }
  },
  "metadata": [
    {
      "format": "STRING"
    }
  ],
  "members": [
    {
      "source": "gravitee",
      "sourceId": "john.doe@example.com",
      "role": "REVIEWER"
    }
  ],
  "status": "ACTIVE"
}