deployedApiApplicationCreate

Creates an Application. Application name, Status, Owner Name and Owner Email are mandatory fields. The application name must be unique across the gateway this application is associated with.

Input Parameters:

• deployedApiApplication: Application configuration including name, status, owner details, and gateway assignment.

Response:

• Returns the created DeployedApiApplication object with complete application details and gateway information.

Example Request:

mutation deployedApiApplicationCreate($deployedApiApplication: DeployedApiApplicationCreateInput!) {
    deployedApiApplicationCreate(deployedApiApplication: $deployedApiApplication) {
        id,
        name,
        gateway {
            id,
            name
        },
        status,
        ownerName,
        ownerUserName,
        ownerEmail,
        contactPhone,
        companyName,
        companyWebsite,
        notes,
        description
    }
}

Variables:

{
    "deployedApiApplication": {
        "gatewayId": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
        "name": "Jiaqi Test Application",
        "ownerName": "Jiaqi",
        "ownerUserName": "jiaqiAdmin",
        "ownerEmail": "jiaqi@xxx.com",
        "status": "ENABLED",
        "contactPhone": "123-456-7890",
        "companyName": "Boomi",
        "companyWebsite": "https://boomi.com",
        "notes": "Test Application",
        "description": "Example Application"
    }
}

deployedApiApplicationCreate(
  deployedApiApplication: DeployedApiApplicationCreateInput!
): DeployedApiApplication!

Arguments

deployedApiApplicationCreate.deployedApiApplication ● DeployedApiApplicationCreateInput! non-null input platform

Type

DeployedApiApplication object platform

type definitions

An API Key is generated for each subscription of the Application so that users can be authorized for specific API access.