getApiKey

Rootly v3.3.0, May 7 26

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Using getApiKey

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 getApiKey(args: GetApiKeyArgs, opts?: InvokeOptions): Promise<GetApiKeyResult>
function getApiKeyOutput(args: GetApiKeyOutputArgs, opts?: InvokeOptions): Output<GetApiKeyResult>

def get_api_key(created_at: Optional[Mapping[str, str]] = None,
                expires_at: Optional[Mapping[str, str]] = None,
                kind: Optional[str] = None,
                last_used_at: Optional[Mapping[str, str]] = None,
                name: Optional[str] = None,
                role_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetApiKeyResult
def get_api_key_output(created_at: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                expires_at: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                kind: pulumi.Input[Optional[str]] = None,
                last_used_at: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                name: pulumi.Input[Optional[str]] = None,
                role_id: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetApiKeyResult]

func LookupApiKey(ctx *Context, args *LookupApiKeyArgs, opts ...InvokeOption) (*LookupApiKeyResult, error)
func LookupApiKeyOutput(ctx *Context, args *LookupApiKeyOutputArgs, opts ...InvokeOption) LookupApiKeyResultOutput

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

public static class GetApiKey 
{
    public static Task<GetApiKeyResult> InvokeAsync(GetApiKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetApiKeyResult> Invoke(GetApiKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
public static Output<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)

fn::invoke:
  function: rootly:index/getApiKey:getApiKey
  arguments:
    # arguments dictionary

The following arguments are supported:

CreatedAt Dictionary<string, string>: Filter by date range using 'lt' and 'gt'.
ExpiresAt Dictionary<string, string>: Filter by date range using 'lt' and 'gt'.
Kind string
LastUsedAt Dictionary<string, string>: Filter by date range using 'lt' and 'gt'.
Name string
RoleId string

CreatedAt map[string]string: Filter by date range using 'lt' and 'gt'.
ExpiresAt map[string]string: Filter by date range using 'lt' and 'gt'.
Kind string
LastUsedAt map[string]string: Filter by date range using 'lt' and 'gt'.
Name string
RoleId string

createdAt Map<String,String>: Filter by date range using 'lt' and 'gt'.
expiresAt Map<String,String>: Filter by date range using 'lt' and 'gt'.
kind String
lastUsedAt Map<String,String>: Filter by date range using 'lt' and 'gt'.
name String
roleId String

createdAt {[key: string]: string}: Filter by date range using 'lt' and 'gt'.
expiresAt {[key: string]: string}: Filter by date range using 'lt' and 'gt'.
kind string
lastUsedAt {[key: string]: string}: Filter by date range using 'lt' and 'gt'.
name string
roleId string

created_at Mapping[str, str]: Filter by date range using 'lt' and 'gt'.
expires_at Mapping[str, str]: Filter by date range using 'lt' and 'gt'.
kind str
last_used_at Mapping[str, str]: Filter by date range using 'lt' and 'gt'.
name str
role_id str

createdAt Map<String>: Filter by date range using 'lt' and 'gt'.
expiresAt Map<String>: Filter by date range using 'lt' and 'gt'.
kind String
lastUsedAt Map<String>: Filter by date range using 'lt' and 'gt'.
name String
roleId String

getApiKey Result

The following output properties are available:

Id string: The ID of this resource.
Kind string
Name string
RoleId string
CreatedAt Dictionary<string, string>: Filter by date range using 'lt' and 'gt'.
ExpiresAt Dictionary<string, string>: Filter by date range using 'lt' and 'gt'.
LastUsedAt Dictionary<string, string>: Filter by date range using 'lt' and 'gt'.

Id string: The ID of this resource.
Kind string
Name string
RoleId string
CreatedAt map[string]string: Filter by date range using 'lt' and 'gt'.
ExpiresAt map[string]string: Filter by date range using 'lt' and 'gt'.
LastUsedAt map[string]string: Filter by date range using 'lt' and 'gt'.

id String: The ID of this resource.
kind String
name String
roleId String
createdAt Map<String,String>: Filter by date range using 'lt' and 'gt'.
expiresAt Map<String,String>: Filter by date range using 'lt' and 'gt'.
lastUsedAt Map<String,String>: Filter by date range using 'lt' and 'gt'.

id string: The ID of this resource.
kind string
name string
roleId string
createdAt {[key: string]: string}: Filter by date range using 'lt' and 'gt'.
expiresAt {[key: string]: string}: Filter by date range using 'lt' and 'gt'.
lastUsedAt {[key: string]: string}: Filter by date range using 'lt' and 'gt'.

id str: The ID of this resource.
kind str
name str
role_id str
created_at Mapping[str, str]: Filter by date range using 'lt' and 'gt'.
expires_at Mapping[str, str]: Filter by date range using 'lt' and 'gt'.
last_used_at Mapping[str, str]: Filter by date range using 'lt' and 'gt'.

id String: The ID of this resource.
kind String
name String
roleId String
createdAt Map<String>: Filter by date range using 'lt' and 'gt'.
expiresAt Map<String>: Filter by date range using 'lt' and 'gt'.
lastUsedAt Map<String>: Filter by date range using 'lt' and 'gt'.

Package Details

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

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

rootly.getApiKey

On this page

On this page

Using getApiKey

getApiKey Result

Package Details

On this page

On this page