Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gcore Provider
  3. API Docs
  4. WaapApiPath
gcore 0.24.1 published on Wednesday, Jun 4, 2025 by g-core
g-core/terraform-provider-gcore

gcore.WaapApiPath

Explore with Pulumi AI

gcore logo
gcore 0.24.1 published on Wednesday, Jun 4, 2025 by g-core
g-core/terraform-provider-gcore

    Represent API Paths for a specific WAAP domain

    Create WaapApiPath Resource

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

    Constructor syntax

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

@overload
def WaapApiPath(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                domain_id: Optional[float] = None,
                http_scheme: Optional[str] = None,
                method: Optional[str] = None,
                path: Optional[str] = None,
                api_groups: Optional[Sequence[str]] = None,
                api_version: Optional[str] = None,
                status: Optional[str] = None,
                tags: Optional[Sequence[str]] = None,
                waap_api_path_id: Optional[str] = None)
    func NewWaapApiPath(ctx *Context, name string, args WaapApiPathArgs, opts ...ResourceOption) (*WaapApiPath, error)
    public WaapApiPath(string name, WaapApiPathArgs args, CustomResourceOptions? opts = null)
    public WaapApiPath(String name, WaapApiPathArgs args)
public WaapApiPath(String name, WaapApiPathArgs args, CustomResourceOptions options)

    type: gcore:WaapApiPath
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 WaapApiPathArgs
    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 WaapApiPathArgs
    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 WaapApiPathArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WaapApiPathArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WaapApiPathArgs
    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 waapApiPathResource = new Gcore.WaapApiPath("waapApiPathResource", new()
{
    DomainId = 0,
    HttpScheme = "string",
    Method = "string",
    Path = "string",
    ApiGroups = new[]
    {
        "string",
    },
    ApiVersion = "string",
    Status = "string",
    Tags = new[]
    {
        "string",
    },
    WaapApiPathId = "string",
});

    example, err := gcore.NewWaapApiPath(ctx, "waapApiPathResource", &gcore.WaapApiPathArgs{
	DomainId:   pulumi.Float64(0),
	HttpScheme: pulumi.String("string"),
	Method:     pulumi.String("string"),
	Path:       pulumi.String("string"),
	ApiGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiVersion: pulumi.String("string"),
	Status:     pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	WaapApiPathId: pulumi.String("string"),
})

    var waapApiPathResource = new WaapApiPath("waapApiPathResource", WaapApiPathArgs.builder()
    .domainId(0.0)
    .httpScheme("string")
    .method("string")
    .path("string")
    .apiGroups("string")
    .apiVersion("string")
    .status("string")
    .tags("string")
    .waapApiPathId("string")
    .build());

    waap_api_path_resource = gcore.WaapApiPath("waapApiPathResource",
    domain_id=0,
    http_scheme="string",
    method="string",
    path="string",
    api_groups=["string"],
    api_version="string",
    status="string",
    tags=["string"],
    waap_api_path_id="string")

    const waapApiPathResource = new gcore.WaapApiPath("waapApiPathResource", {
    domainId: 0,
    httpScheme: "string",
    method: "string",
    path: "string",
    apiGroups: ["string"],
    apiVersion: "string",
    status: "string",
    tags: ["string"],
    waapApiPathId: "string",
});

    type: gcore:WaapApiPath
properties:
    apiGroups:
        - string
    apiVersion: string
    domainId: 0
    httpScheme: string
    method: string
    path: string
    status: string
    tags:
        - string
    waapApiPathId: string

    WaapApiPath 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 WaapApiPath resource accepts the following input properties:

    DomainId double
    The WAAP domain ID for which the API Path is configured.
    HttpScheme string
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    Method string
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    Path string
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    ApiGroups List<string>
    An array of API groups associated with the API path.
    ApiVersion string
    The API version.
    Status string
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    Tags List<string>
    An array of tags associated with the API path.
    WaapApiPathId string
    The ID of this resource.
    DomainId float64
    The WAAP domain ID for which the API Path is configured.
    HttpScheme string
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    Method string
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    Path string
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    ApiGroups []string
    An array of API groups associated with the API path.
    ApiVersion string
    The API version.
    Status string
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    Tags []string
    An array of tags associated with the API path.
    WaapApiPathId string
    The ID of this resource.
    domainId Double
    The WAAP domain ID for which the API Path is configured.
    httpScheme String
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    method String
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    path String
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    apiGroups List<String>
    An array of API groups associated with the API path.
    apiVersion String
    The API version.
    status String
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    tags List<String>
    An array of tags associated with the API path.
    waapApiPathId String
    The ID of this resource.
    domainId number
    The WAAP domain ID for which the API Path is configured.
    httpScheme string
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    method string
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    path string
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    apiGroups string[]
    An array of API groups associated with the API path.
    apiVersion string
    The API version.
    status string
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    tags string[]
    An array of tags associated with the API path.
    waapApiPathId string
    The ID of this resource.
    domain_id float
    The WAAP domain ID for which the API Path is configured.
    http_scheme str
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    method str
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    path str
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    api_groups Sequence[str]
    An array of API groups associated with the API path.
    api_version str
    The API version.
    status str
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    tags Sequence[str]
    An array of tags associated with the API path.
    waap_api_path_id str
    The ID of this resource.
    domainId Number
    The WAAP domain ID for which the API Path is configured.
    httpScheme String
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    method String
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    path String
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    apiGroups List<String>
    An array of API groups associated with the API path.
    apiVersion String
    The API version.
    status String
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    tags List<String>
    An array of tags associated with the API path.
    waapApiPathId String
    The ID of this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WaapApiPath Resource

    Get an existing WaapApiPath 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?: WaapApiPathState, opts?: CustomResourceOptions): WaapApiPath
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_groups: Optional[Sequence[str]] = None,
        api_version: Optional[str] = None,
        domain_id: Optional[float] = None,
        http_scheme: Optional[str] = None,
        method: Optional[str] = None,
        path: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        waap_api_path_id: Optional[str] = None) -> WaapApiPath
    func GetWaapApiPath(ctx *Context, name string, id IDInput, state *WaapApiPathState, opts ...ResourceOption) (*WaapApiPath, error)
    public static WaapApiPath Get(string name, Input<string> id, WaapApiPathState? state, CustomResourceOptions? opts = null)
    public static WaapApiPath get(String name, Output<String> id, WaapApiPathState state, CustomResourceOptions options)
    resources:  _:    type: gcore:WaapApiPath    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:
    ApiGroups List<string>
    An array of API groups associated with the API path.
    ApiVersion string
    The API version.
    DomainId double
    The WAAP domain ID for which the API Path is configured.
    HttpScheme string
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    Method string
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    Path string
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    Status string
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    Tags List<string>
    An array of tags associated with the API path.
    WaapApiPathId string
    The ID of this resource.
    ApiGroups []string
    An array of API groups associated with the API path.
    ApiVersion string
    The API version.
    DomainId float64
    The WAAP domain ID for which the API Path is configured.
    HttpScheme string
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    Method string
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    Path string
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    Status string
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    Tags []string
    An array of tags associated with the API path.
    WaapApiPathId string
    The ID of this resource.
    apiGroups List<String>
    An array of API groups associated with the API path.
    apiVersion String
    The API version.
    domainId Double
    The WAAP domain ID for which the API Path is configured.
    httpScheme String
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    method String
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    path String
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    status String
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    tags List<String>
    An array of tags associated with the API path.
    waapApiPathId String
    The ID of this resource.
    apiGroups string[]
    An array of API groups associated with the API path.
    apiVersion string
    The API version.
    domainId number
    The WAAP domain ID for which the API Path is configured.
    httpScheme string
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    method string
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    path string
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    status string
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    tags string[]
    An array of tags associated with the API path.
    waapApiPathId string
    The ID of this resource.
    api_groups Sequence[str]
    An array of API groups associated with the API path.
    api_version str
    The API version.
    domain_id float
    The WAAP domain ID for which the API Path is configured.
    http_scheme str
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    method str
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    path str
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    status str
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    tags Sequence[str]
    An array of tags associated with the API path.
    waap_api_path_id str
    The ID of this resource.
    apiGroups List<String>
    An array of API groups associated with the API path.
    apiVersion String
    The API version.
    domainId Number
    The WAAP domain ID for which the API Path is configured.
    httpScheme String
    The different HTTP schemes an API path can have. It must be one of these values: HTTP, HTTPS.
    method String
    The different methods an API path can have. It must be one of these values: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS.
    path String
    The API path, locations that are saved for resource IDs will be put in curly brackets.
    status String
    The status of the discovered API path. It must be one of these values: CONFIRMEDAPI, POTENTIALAPI, NOTAPI, DELISTEDAPI
    tags List<String>
    An array of tags associated with the API path.
    waapApiPathId String
    The ID of this resource.

    Import

    import using <domain_id>:<path_id>

    $ pulumi import gcore:index/waapApiPath:WaapApiPath api_path 83429:447d2959-8ae0-4ca0-8d47-9f050a3637d7

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    gcore 0.24.1 published on Wednesday, Jun 4, 2025 by g-core
    g-core/terraform-provider-gcore