Akamai
getAppSecApiEndpoints
Scopes: Security configuration; security policy
Returns information about the API endpoints associated with a security policy or configuration. The returned information is described in the Endpoint members section of the Application Security API documentation.
Related API Endpoint: /appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-endpoints
Output Options
The following options can be used to determine the information returned, and how that returned information is formatted:
id_list
. List of API endpoint IDs.json
. JSON-formatted list of information about the API endpoints.output_text
. Tabular report showing the ID and name of the API endpoints.
Example Usage
using Pulumi;
using Akamai = Pulumi.Akamai;
class MyStack : Stack
{
public MyStack()
{
var apiEndpoints = Output.Create(Akamai.GetAppSecApiEndpoints.InvokeAsync(new Akamai.GetAppSecApiEndpointsArgs
{
ApiName = "Contracts",
ConfigId = 58843,
}));
}
}
package main
import (
"github.com/pulumi/pulumi-akamai/sdk/v2/go/akamai"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := akamai.GetAppSecApiEndpoints(ctx, &GetAppSecApiEndpointsArgs{
ApiName: pulumi.StringRef("Contracts"),
ConfigId: 58843,
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_akamai as akamai
api_endpoints = akamai.get_app_sec_api_endpoints(api_name="Contracts",
config_id=58843)
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";
const apiEndpoints = pulumi.output(akamai.getAppSecApiEndpoints({
apiName: "Contracts",
configId: 58843,
}));
Coming soon!
Using getAppSecApiEndpoints
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAppSecApiEndpoints(args: GetAppSecApiEndpointsArgs, opts?: InvokeOptions): Promise<GetAppSecApiEndpointsResult>
function getAppSecApiEndpointsOutput(args: GetAppSecApiEndpointsOutputArgs, opts?: InvokeOptions): Output<GetAppSecApiEndpointsResult>
def get_app_sec_api_endpoints(api_name: Optional[str] = None,
config_id: Optional[int] = None,
security_policy_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAppSecApiEndpointsResult
def get_app_sec_api_endpoints_output(api_name: Optional[pulumi.Input[str]] = None,
config_id: Optional[pulumi.Input[int]] = None,
security_policy_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAppSecApiEndpointsResult]
func GetAppSecApiEndpoints(ctx *Context, args *GetAppSecApiEndpointsArgs, opts ...InvokeOption) (*GetAppSecApiEndpointsResult, error)
func GetAppSecApiEndpointsOutput(ctx *Context, args *GetAppSecApiEndpointsOutputArgs, opts ...InvokeOption) GetAppSecApiEndpointsResultOutput
> Note: This function is named GetAppSecApiEndpoints
in the Go SDK.
public static class GetAppSecApiEndpoints
{
public static Task<GetAppSecApiEndpointsResult> InvokeAsync(GetAppSecApiEndpointsArgs args, InvokeOptions? opts = null)
public static Output<GetAppSecApiEndpointsResult> Invoke(GetAppSecApiEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAppSecApiEndpointsResult> getAppSecApiEndpoints(GetAppSecApiEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: akamai:index/getAppSecApiEndpoints:getAppSecApiEndpoints
Arguments:
# Arguments dictionary
The following arguments are supported:
- Config
Id int . Unique identifier of the security configuration associated with the API endpoints.
- Api
Name string . Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.
- Security
Policy stringId . Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.
- Config
Id int . Unique identifier of the security configuration associated with the API endpoints.
- Api
Name string . Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.
- Security
Policy stringId . Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.
- config
Id Integer . Unique identifier of the security configuration associated with the API endpoints.
- api
Name String . Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.
- security
Policy StringId . Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.
- config
Id number . Unique identifier of the security configuration associated with the API endpoints.
- api
Name string . Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.
- security
Policy stringId . Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.
- config_
id int . Unique identifier of the security configuration associated with the API endpoints.
- api_
name str . Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.
- security_
policy_ strid . Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.
- config
Id Number . Unique identifier of the security configuration associated with the API endpoints.
- api
Name String . Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.
- security
Policy StringId . Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.
getAppSecApiEndpoints Result
The following output properties are available:
- Config
Id int - Id string
The provider-assigned unique ID for this managed resource.
- Id
Lists List<int> - Json string
- Output
Text string - Api
Name string - Security
Policy stringId
- Config
Id int - Id string
The provider-assigned unique ID for this managed resource.
- Id
Lists []int - Json string
- Output
Text string - Api
Name string - Security
Policy stringId
- config
Id Integer - id String
The provider-assigned unique ID for this managed resource.
- id
Lists List - json String
- output
Text String - api
Name String - security
Policy StringId
- config
Id number - id string
The provider-assigned unique ID for this managed resource.
- id
Lists number[] - json string
- output
Text string - api
Name string - security
Policy stringId
- config_
id int - id str
The provider-assigned unique ID for this managed resource.
- id_
lists Sequence[int] - json str
- output_
text str - api_
name str - security_
policy_ strid
- config
Id Number - id String
The provider-assigned unique ID for this managed resource.
- id
Lists List - json String
- output
Text String - api
Name String - security
Policy StringId
Package Details
- Repository
- https://github.com/pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
akamai
Terraform Provider.