Set-FilesApiKey

Update API Key.

Syntax

Id (Default)

Set-FilesApiKey [-Id] <System.Int64> [-Description <System.String>] [-ExpiresAt <System.DateTimeOffset>] [-Name <System.String>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Set-FilesApiKey [-Description <System.String>] [-ExpiresAt <System.DateTimeOffset>] [-Name <System.String>] -InputObject <FilesCom.PowerShell.Models.ApiKey> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Update API Key.

The command accepts api keys from the pipeline as -InputObject, and uses each one's Id and the connection that fetched it.

When given -InputObject, the command updates that object with the values Files.com returns and writes it.

The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it. It asks for confirmation by default; use -Confirm:$false in scripts that have already decided.

Examples

Example 1: Update API Key

Set-FilesApiKey -Id 1 -Description 'example' -ExpiresAt (Get-Date).AddDays(30)

Writes the api key as Files.com returns it.

Example 2: Act on api keys from the pipeline

Get-FilesApiKey -Id 1 | Set-FilesApiKey -Description 'example' -ExpiresAt (Get-Date).AddDays(30)

Takes the api key from the pipeline and uses its Id and connection.

Example 3: Preview the change

Set-FilesApiKey -Id 1 -Description 'example' -ExpiresAt (Get-Date).AddDays(30) -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Id

Api Key ID.

  • Type: System.Int64
  • Parameter sets: Id (required, position 0)

-Description

User-supplied description of API key.

  • Type: System.String
  • Parameter sets: Id, InputObject

-ExpiresAt

API Key expiration date Give a DateTime from Get-Date, a DateTimeOffset, or ISO 8601 text with an offset such as 2026-01-31T14:00:00Z.

  • Type: System.DateTimeOffset
  • Parameter sets: Id, InputObject

-Name

Internal name for the API Key. For your use.

  • Type: System.String
  • Parameter sets: Id, InputObject

-InputObject

The api key to act on, such as one written by another command of the module, from the pipeline. The command uses its Id and the connection that fetched it.

  • Type: FilesCom.PowerShell.Models.ApiKey
  • Parameter sets: InputObject (required)

-Connection

The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.

  • Type: FilesCom.PowerShell.FilesConnection
  • Parameter sets: (All)

-WorkspaceScope

Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.

  • Type: System.Int64
  • Parameter sets: (All)

-NoWorkspaceScope

Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.

  • Type: System.Management.Automation.SwitchParameter
  • Parameter sets: (All)

-Confirm

Prompts you for confirmation before running the cmdlet.

  • Type: System.Management.Automation.SwitchParameter
  • Confirm impact: High. At the default $ConfirmPreference of High, the command asks before each change; -Confirm:$false runs it without asking.

-WhatIf

Shows what the cmdlet would change without sending anything to Files.com.

  • Type: System.Management.Automation.SwitchParameter

Common Parameters

This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.

Inputs

  • FilesCom.PowerShell.Models.ApiKey: a api key from another command of the module, as -InputObject.

Outputs

  • FilesCom.PowerShell.Models.ApiKey: the api key as Files.com returned it.

Notes

Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.