FIfiles
gpg_keys
GPG Keys

Create GPG Key

Changed on

Create GPG Key

post/gpg_keys

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/gpg_keys
  • Auth
    none declared

Request body multipart/form-data

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

partner_idinteger

Partner ID who owns this GPG Key, if applicable.

public_keystring

The GPG public key

private_keystring

The GPG private key

private_key_passwordstring

The GPG private key password

namestring required

GPG key name.

workspace_idinteger

Workspace ID (0 for default workspace).

generate_expires_atstring date-time

Expiration date of the key. Used for the generation of the key. Will be ignored if generate_keypair is false.

generate_keypairboolean

If true, generate a new GPG key pair. Can not be used with public_key/private_key

generate_full_namestring

Full name of the key owner. Used for the generation of the key. Will be ignored if generate_keypair is false.

generate_emailstring

Email address of the key owner. Used for the generation of the key. Will be ignored if generate_keypair is false.

Example request

{
  "partner_id": 1,
  "name": "key name",
  "generate_expires_at": "2025-06-19 12:00:00",
  "generate_full_name": "John Doe",
  "generate_email": "jdoe@example.com"
}

Response

The GpgKeys object.

idinteger

GPG key ID.

workspace_idinteger

Workspace ID (0 for default workspace).

expires_atstring date-time

GPG key expiration date.

namestring

GPG key name.

partner_idinteger

Partner ID who owns this GPG Key, if applicable.

partner_namestring

Name of the Partner who owns this GPG Key, if applicable.

user_idinteger

User ID who owns this GPG Key, if applicable.

public_key_md5string

MD5 hash of the GPG public key

private_key_md5string

MD5 hash of the GPG private key.

generated_public_keystring

GPG public key

generated_private_keystring

GPG private key.

private_key_password_md5string

GPG private key password. Only required for password protected keys.

Example response

{
  "id": 1,
  "expires_at": "2000-01-01T01:00:00Z",
  "name": "key name",
  "partner_id": 1,
  "partner_name": "example",
  "user_id": 1,
  "public_key_md5": "7f8bc1210b09b9ddf469e6b6b8920e76",
  "private_key_md5": "ab236cfe4a195f0226bc2e674afdd6b0",
  "generated_public_key": "7f8bc1210b09b9ddf469e6b6b8920e76",
  "generated_private_key": "ab236cfe4a195f0226bc2e674afdd6b0",
  "private_key_password_md5": "[the GPG private key password]"
}

Changes