1. Packages
  2. Akamai
  3. API Docs
  4. ApidefinitionsApi
Akamai v10.1.0 published on Thursday, Nov 6, 2025 by Pulumi
pulumi/pulumi-akamai

akamai.ApidefinitionsApi

Start a Neo task
Explain and create an akamai.ApidefinitionsApi resource
akamai logo
Akamai v10.1.0 published on Thursday, Nov 6, 2025 by Pulumi
pulumi/pulumi-akamai

    Create ApidefinitionsApi Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApidefinitionsApi(name: string, args: ApidefinitionsApiArgs, opts?: CustomResourceOptions);
    @overload
def ApidefinitionsApi(resource_name: str,
                      args: ApidefinitionsApiArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ApidefinitionsApi(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      api: Optional[str] = None,
                      contract_id: Optional[str] = None,
                      group_id: Optional[int] = None,
                      production_version: Optional[int] = None,
                      staging_version: Optional[int] = None)
    func NewApidefinitionsApi(ctx *Context, name string, args ApidefinitionsApiArgs, opts ...ResourceOption) (*ApidefinitionsApi, error)
    public ApidefinitionsApi(string name, ApidefinitionsApiArgs args, CustomResourceOptions? opts = null)
    public ApidefinitionsApi(String name, ApidefinitionsApiArgs args)
public ApidefinitionsApi(String name, ApidefinitionsApiArgs args, CustomResourceOptions options)

    type: akamai:ApidefinitionsApi
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApidefinitionsApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApidefinitionsApiArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApidefinitionsApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApidefinitionsApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApidefinitionsApiArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apidefinitionsApiResource = new Akamai.ApidefinitionsApi("apidefinitionsApiResource", new()
{
    Api = "string",
    ContractId = "string",
    GroupId = 0,
    ProductionVersion = 0,
    StagingVersion = 0,
});

    example, err := akamai.NewApidefinitionsApi(ctx, "apidefinitionsApiResource", &akamai.ApidefinitionsApiArgs{
	Api:               pulumi.String("string"),
	ContractId:        pulumi.String("string"),
	GroupId:           pulumi.Int(0),
	ProductionVersion: pulumi.Int(0),
	StagingVersion:    pulumi.Int(0),
})

    var apidefinitionsApiResource = new ApidefinitionsApi("apidefinitionsApiResource", ApidefinitionsApiArgs.builder()
    .api("string")
    .contractId("string")
    .groupId(0)
    .productionVersion(0)
    .stagingVersion(0)
    .build());

    apidefinitions_api_resource = akamai.ApidefinitionsApi("apidefinitionsApiResource",
    api="string",
    contract_id="string",
    group_id=0,
    production_version=0,
    staging_version=0)

    const apidefinitionsApiResource = new akamai.ApidefinitionsApi("apidefinitionsApiResource", {
    api: "string",
    contractId: "string",
    groupId: 0,
    productionVersion: 0,
    stagingVersion: 0,
});

    type: akamai:ApidefinitionsApi
properties:
    api: string
    contractId: string
    groupId: 0
    productionVersion: 0
    stagingVersion: 0

    ApidefinitionsApi Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApidefinitionsApi resource accepts the following input properties:

    Api string
    JSON-formatted information about the API configuration
    ContractId string
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    GroupId int
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    ProductionVersion int
    Version of the API currently deployed in production
    StagingVersion int
    Version of the API currently deployed in staging
    Api string
    JSON-formatted information about the API configuration
    ContractId string
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    GroupId int
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    ProductionVersion int
    Version of the API currently deployed in production
    StagingVersion int
    Version of the API currently deployed in staging
    api String
    JSON-formatted information about the API configuration
    contractId String
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    groupId Integer
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    productionVersion Integer
    Version of the API currently deployed in production
    stagingVersion Integer
    Version of the API currently deployed in staging
    api string
    JSON-formatted information about the API configuration
    contractId string
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    groupId number
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    productionVersion number
    Version of the API currently deployed in production
    stagingVersion number
    Version of the API currently deployed in staging
    api str
    JSON-formatted information about the API configuration
    contract_id str
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    group_id int
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    production_version int
    Version of the API currently deployed in production
    staging_version int
    Version of the API currently deployed in staging
    api String
    JSON-formatted information about the API configuration
    contractId String
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    groupId Number
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    productionVersion Number
    Version of the API currently deployed in production
    stagingVersion Number
    Version of the API currently deployed in staging

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApidefinitionsApi resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LatestVersion int
    Latest version of the API
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestVersion int
    Latest version of the API
    id String
    The provider-assigned unique ID for this managed resource.
    latestVersion Integer
    Latest version of the API
    id string
    The provider-assigned unique ID for this managed resource.
    latestVersion number
    Latest version of the API
    id str
    The provider-assigned unique ID for this managed resource.
    latest_version int
    Latest version of the API
    id String
    The provider-assigned unique ID for this managed resource.
    latestVersion Number
    Latest version of the API

    Look up Existing ApidefinitionsApi Resource

    Get an existing ApidefinitionsApi resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApidefinitionsApiState, opts?: CustomResourceOptions): ApidefinitionsApi
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api: Optional[str] = None,
        contract_id: Optional[str] = None,
        group_id: Optional[int] = None,
        latest_version: Optional[int] = None,
        production_version: Optional[int] = None,
        staging_version: Optional[int] = None) -> ApidefinitionsApi
    func GetApidefinitionsApi(ctx *Context, name string, id IDInput, state *ApidefinitionsApiState, opts ...ResourceOption) (*ApidefinitionsApi, error)
    public static ApidefinitionsApi Get(string name, Input<string> id, ApidefinitionsApiState? state, CustomResourceOptions? opts = null)
    public static ApidefinitionsApi get(String name, Output<String> id, ApidefinitionsApiState state, CustomResourceOptions options)
    resources:  _:    type: akamai:ApidefinitionsApi    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Api string
    JSON-formatted information about the API configuration
    ContractId string
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    GroupId int
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    LatestVersion int
    Latest version of the API
    ProductionVersion int
    Version of the API currently deployed in production
    StagingVersion int
    Version of the API currently deployed in staging
    Api string
    JSON-formatted information about the API configuration
    ContractId string
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    GroupId int
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    LatestVersion int
    Latest version of the API
    ProductionVersion int
    Version of the API currently deployed in production
    StagingVersion int
    Version of the API currently deployed in staging
    api String
    JSON-formatted information about the API configuration
    contractId String
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    groupId Integer
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    latestVersion Integer
    Latest version of the API
    productionVersion Integer
    Version of the API currently deployed in production
    stagingVersion Integer
    Version of the API currently deployed in staging
    api string
    JSON-formatted information about the API configuration
    contractId string
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    groupId number
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    latestVersion number
    Latest version of the API
    productionVersion number
    Version of the API currently deployed in production
    stagingVersion number
    Version of the API currently deployed in staging
    api str
    JSON-formatted information about the API configuration
    contract_id str
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    group_id int
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    latest_version int
    Latest version of the API
    production_version int
    Version of the API currently deployed in production
    staging_version int
    Version of the API currently deployed in staging
    api String
    JSON-formatted information about the API configuration
    contractId String
    The unique identifier for the contract (without the 'ctr_' prefix) assigned to the API.
    groupId Number
    The unique identifier for the group (without the 'grp_' prefix) assigned to the API.
    latestVersion Number
    Latest version of the API
    productionVersion Number
    Version of the API currently deployed in production
    stagingVersion Number
    Version of the API currently deployed in staging

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Akamai v10.1.0 published on Thursday, Nov 6, 2025 by Pulumi
    pulumi/pulumi-akamai
      Meet Neo: Your AI Platform Teammate