deployedApiCreate

Deploys the API. Adds plans, roles and auth sources to deployment.

Input Parameters:

• deployedApi: Deployment configuration including component ID, environment, authentication, plans, and version details.

Response:

• Returns the created DeployedApi object with full deployment information.

Example Request:

mutation {
    deployedApiCreate(deployedApi: {
        apiComponentId: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
        environmentId: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
        planIds: ["<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>"]
    }) {
        id,
        component {
            id,
            name,
            type,
            version,
            definition,
            folderLocation,
            deleted,
            latestVersion
        },
        metadata {
            title,
            version,
            description,
            apiProxyServerUrl,
            apiPackagedComponentVersion,
            componentType
        },
        authSource {
            id,
            name,
            description
        },
        environment {
            id,
            name,
            publishedName,
            classification
        },
        endpoints {
            type,
            basePath,
            contextPath
        },
        keylessPlan {
            id,
            name,
            description,
            status,
            maxMessageSize,
            rateLimit,
            rateLimitPeriod,
            quotaLimit,
            quotaLimitPeriod,
            quotaLimitTimezone,
            applicationCount
        },
        plans {
            id,
            name,
            description,
            status,
            maxMessageSize,
            rateLimit,
            rateLimitPeriod,
            quotaLimit,
            quotaLimitPeriod,
            quotaLimitTimezone,
            applicationCount
        },
        executionSettings {
            concurrency,
            retries,
            retryCases,
            connectTimeout,
            executionTimeout,
            subscriptionCacheSize
        },
        requiredRoles {
            id,
            name,
            description
        },
        customPolicies {
            path,
            when
        },
        subscriptions {
            apiKeyId,
            status,
            startDate,
            expirationDate,
            approvalDate,
            consumerMessage,
            producerMessage,
            generatedBy,
            generatedDate,
            statusChangedBy,
            statusChangedDate
        },
        planMappings {
            id
        },
        version,
        documentation {
            oas,
            wsdl
        },
        cors {
            origins,
            methods,
            headers,
            allowCredentials,
            maxAge,
            exposeHeaders,
            enableCors,
            runPolicies
        },
        certificateAuthentication {
            certificateAuthRequired
        },
        customPolicyPathMode,
        branch {
            branchName,
            branchDescription,
            isDeleted,
            isDefaultBranch
        }
    }
}

deployedApiCreate(
  deployedApi: DeployedApiCreateInput!
): DeployedApi!

Arguments

deployedApiCreate.deployedApi ● DeployedApiCreateInput! non-null input platform

Type

DeployedApi object platform

Represents an API deployed to a specific environment and the various information associated with it (Component, ApiComponentMetadata, Environment, DeployedApiEndpoint, Keyless Plan, number of plans associated with Deployed Api, Execution Settings and required roles)