Cloudflare v6.1.2, Apr 28 25

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getApiToken

Explore with Pulumi AI

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleApiToken = cloudflare.getApiToken({
    tokenId: "ed17574386854bf78a67040be0a770b0",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_api_token = cloudflare.get_api_token(token_id="ed17574386854bf78a67040be0a770b0")

package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupApiToken(ctx, &cloudflare.LookupApiTokenArgs{
			TokenId: pulumi.StringRef("ed17574386854bf78a67040be0a770b0"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleApiToken = Cloudflare.GetApiToken.Invoke(new()
    {
        TokenId = "ed17574386854bf78a67040be0a770b0",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetApiTokenArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleApiToken = CloudflareFunctions.getApiToken(GetApiTokenArgs.builder()
            .tokenId("ed17574386854bf78a67040be0a770b0")
            .build());

    }
}

variables:
  exampleApiToken:
    fn::invoke:
      function: cloudflare:getApiToken
      arguments:
        tokenId: ed17574386854bf78a67040be0a770b0

Using getApiToken

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 getApiToken(args: GetApiTokenArgs, opts?: InvokeOptions): Promise<GetApiTokenResult>
function getApiTokenOutput(args: GetApiTokenOutputArgs, opts?: InvokeOptions): Output<GetApiTokenResult>

def get_api_token(filter: Optional[GetApiTokenFilter] = None,
                  token_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetApiTokenResult
def get_api_token_output(filter: Optional[pulumi.Input[GetApiTokenFilterArgs]] = None,
                  token_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetApiTokenResult]

func LookupApiToken(ctx *Context, args *LookupApiTokenArgs, opts ...InvokeOption) (*LookupApiTokenResult, error)
func LookupApiTokenOutput(ctx *Context, args *LookupApiTokenOutputArgs, opts ...InvokeOption) LookupApiTokenResultOutput

> Note: This function is named LookupApiToken in the Go SDK.

public static class GetApiToken 
{
    public static Task<GetApiTokenResult> InvokeAsync(GetApiTokenArgs args, InvokeOptions? opts = null)
    public static Output<GetApiTokenResult> Invoke(GetApiTokenInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiTokenResult> getApiToken(GetApiTokenArgs args, InvokeOptions options)
public static Output<GetApiTokenResult> getApiToken(GetApiTokenArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getApiToken:getApiToken
  arguments:
    # arguments dictionary

The following arguments are supported:

Filter GetApiTokenFilter
TokenId string: Token identifier tag.

Filter GetApiTokenFilter
TokenId string: Token identifier tag.

filter GetApiTokenFilter
tokenId String: Token identifier tag.

filter GetApiTokenFilter
tokenId string: Token identifier tag.

filter GetApiTokenFilter
token_id str: Token identifier tag.

filter Property Map
tokenId String: Token identifier tag.

getApiToken Result

The following output properties are available:

Condition GetApiTokenCondition
ExpiresOn string: The expiration time on or after which the JWT MUST NOT be accepted for processing.
Id string: Token identifier tag.
IssuedOn string: The time on which the token was created.
LastUsedOn string: Last time the token was used.
ModifiedOn string: Last time the token was modified.
Name string: Token name.
NotBefore string: The time before which the token MUST NOT be accepted for processing.
Policies List<GetApiTokenPolicy>: List of access policies assigned to the token.
Status string: Status of the token. Available values: "active", "disabled", "expired".
Filter GetApiTokenFilter
TokenId string: Token identifier tag.

Condition GetApiTokenCondition
ExpiresOn string: The expiration time on or after which the JWT MUST NOT be accepted for processing.
Id string: Token identifier tag.
IssuedOn string: The time on which the token was created.
LastUsedOn string: Last time the token was used.
ModifiedOn string: Last time the token was modified.
Name string: Token name.
NotBefore string: The time before which the token MUST NOT be accepted for processing.
Policies []GetApiTokenPolicy: List of access policies assigned to the token.
Status string: Status of the token. Available values: "active", "disabled", "expired".
Filter GetApiTokenFilter
TokenId string: Token identifier tag.

condition GetApiTokenCondition
expiresOn String: The expiration time on or after which the JWT MUST NOT be accepted for processing.
id String: Token identifier tag.
issuedOn String: The time on which the token was created.
lastUsedOn String: Last time the token was used.
modifiedOn String: Last time the token was modified.
name String: Token name.
notBefore String: The time before which the token MUST NOT be accepted for processing.
policies List<GetApiTokenPolicy>: List of access policies assigned to the token.
status String: Status of the token. Available values: "active", "disabled", "expired".
filter GetApiTokenFilter
tokenId String: Token identifier tag.

condition GetApiTokenCondition
expiresOn string: The expiration time on or after which the JWT MUST NOT be accepted for processing.
id string: Token identifier tag.
issuedOn string: The time on which the token was created.
lastUsedOn string: Last time the token was used.
modifiedOn string: Last time the token was modified.
name string: Token name.
notBefore string: The time before which the token MUST NOT be accepted for processing.
policies GetApiTokenPolicy[]: List of access policies assigned to the token.
status string: Status of the token. Available values: "active", "disabled", "expired".
filter GetApiTokenFilter
tokenId string: Token identifier tag.

condition GetApiTokenCondition
expires_on str: The expiration time on or after which the JWT MUST NOT be accepted for processing.
id str: Token identifier tag.
issued_on str: The time on which the token was created.
last_used_on str: Last time the token was used.
modified_on str: Last time the token was modified.
name str: Token name.
not_before str: The time before which the token MUST NOT be accepted for processing.
policies Sequence[GetApiTokenPolicy]: List of access policies assigned to the token.
status str: Status of the token. Available values: "active", "disabled", "expired".
filter GetApiTokenFilter
token_id str: Token identifier tag.

condition Property Map
expiresOn String: The expiration time on or after which the JWT MUST NOT be accepted for processing.
id String: Token identifier tag.
issuedOn String: The time on which the token was created.
lastUsedOn String: Last time the token was used.
modifiedOn String: Last time the token was modified.
name String: Token name.
notBefore String: The time before which the token MUST NOT be accepted for processing.
policies List<Property Map>: List of access policies assigned to the token.
status String: Status of the token. Available values: "active", "disabled", "expired".
filter Property Map
tokenId String: Token identifier tag.

Supporting Types

GetApiTokenCondition

RequestIp GetApiTokenConditionRequestIp: Client IP restrictions.

RequestIp GetApiTokenConditionRequestIp: Client IP restrictions.

requestIp GetApiTokenConditionRequestIp: Client IP restrictions.

requestIp GetApiTokenConditionRequestIp: Client IP restrictions.

request_ip GetApiTokenConditionRequestIp: Client IP restrictions.

requestIp Property Map: Client IP restrictions.

GetApiTokenConditionRequestIp

Ins List<string>: List of IPv4/IPv6 CIDR addresses.
NotIns List<string>: List of IPv4/IPv6 CIDR addresses.

Ins []string: List of IPv4/IPv6 CIDR addresses.
NotIns []string: List of IPv4/IPv6 CIDR addresses.

ins List<String>: List of IPv4/IPv6 CIDR addresses.
notIns List<String>: List of IPv4/IPv6 CIDR addresses.

ins string[]: List of IPv4/IPv6 CIDR addresses.
notIns string[]: List of IPv4/IPv6 CIDR addresses.

ins Sequence[str]: List of IPv4/IPv6 CIDR addresses.
not_ins Sequence[str]: List of IPv4/IPv6 CIDR addresses.

ins List<String>: List of IPv4/IPv6 CIDR addresses.
notIns List<String>: List of IPv4/IPv6 CIDR addresses.

GetApiTokenFilter

Direction string: Direction to order results. Available values: "asc", "desc".

Direction string: Direction to order results. Available values: "asc", "desc".

direction String: Direction to order results. Available values: "asc", "desc".

direction string: Direction to order results. Available values: "asc", "desc".

direction str: Direction to order results. Available values: "asc", "desc".

direction String: Direction to order results. Available values: "asc", "desc".

GetApiTokenPolicy

Effect string: Allow or deny operations against the resources. Available values: "allow", "deny".
Id string: Policy identifier.
PermissionGroups List<GetApiTokenPolicyPermissionGroup>: A set of permission groups that are specified to the policy.
Resources Dictionary<string, string>: A list of resource names that the policy applies to.

Effect string: Allow or deny operations against the resources. Available values: "allow", "deny".
Id string: Policy identifier.
PermissionGroups []GetApiTokenPolicyPermissionGroup: A set of permission groups that are specified to the policy.
Resources map[string]string: A list of resource names that the policy applies to.

effect String: Allow or deny operations against the resources. Available values: "allow", "deny".
id String: Policy identifier.
permissionGroups List<GetApiTokenPolicyPermissionGroup>: A set of permission groups that are specified to the policy.
resources Map<String,String>: A list of resource names that the policy applies to.

effect string: Allow or deny operations against the resources. Available values: "allow", "deny".
id string: Policy identifier.
permissionGroups GetApiTokenPolicyPermissionGroup[]: A set of permission groups that are specified to the policy.
resources {[key: string]: string}: A list of resource names that the policy applies to.

effect str: Allow or deny operations against the resources. Available values: "allow", "deny".
id str: Policy identifier.
permission_groups Sequence[GetApiTokenPolicyPermissionGroup]: A set of permission groups that are specified to the policy.
resources Mapping[str, str]: A list of resource names that the policy applies to.

effect String: Allow or deny operations against the resources. Available values: "allow", "deny".
id String: Policy identifier.
permissionGroups List<Property Map>: A set of permission groups that are specified to the policy.
resources Map<String>: A list of resource names that the policy applies to.

GetApiTokenPolicyPermissionGroup

Id string: Identifier of the group.
Meta GetApiTokenPolicyPermissionGroupMeta: Attributes associated to the permission group.
Name string: Name of the group.

Id string: Identifier of the group.
Meta GetApiTokenPolicyPermissionGroupMeta: Attributes associated to the permission group.
Name string: Name of the group.

id String: Identifier of the group.
meta GetApiTokenPolicyPermissionGroupMeta: Attributes associated to the permission group.
name String: Name of the group.

id string: Identifier of the group.
meta GetApiTokenPolicyPermissionGroupMeta: Attributes associated to the permission group.
name string: Name of the group.

id str: Identifier of the group.
meta GetApiTokenPolicyPermissionGroupMeta: Attributes associated to the permission group.
name str: Name of the group.

id String: Identifier of the group.
meta Property Map: Attributes associated to the permission group.
name String: Name of the group.

GetApiTokenPolicyPermissionGroupMeta

Key string
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value String

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getApiToken

On this page

On this page

Example Usage

Using getApiToken

getApiToken Result

Supporting Types

GetApiTokenCondition

GetApiTokenConditionRequestIp

GetApiTokenFilter

GetApiTokenPolicy

GetApiTokenPolicyPermissionGroup

GetApiTokenPolicyPermissionGroupMeta

Package Details

On this page

On this page