Keys

The following endpoints allow you to manage and retrieve metadata for authentication keys in your custom keychain. You can use these keys to manage your authentication in the HTTP or encryptor apps similarly to other connections.

List keys

get

/keys

Gets the list of keys in your custom keychain. You can use the typeName query parameter to filter your keys based on their type. Run the list of key types API call to get a list of available key types.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters

teamIdintegerRequired

The ID of the team.

Example: 22

typeNamestring · enumOptional

Use the key type to get only keys with the specified type. You can use the API call GET /keys/types to list available key types.

Example: basicauthPossible values:

Responses

200

Successful response

application/json

get

/keys

GET /api/v2/keys?teamId=1 HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "keys": [
    {
      "id": 1,
      "name": "My HTTP Basic Auth key"
    },
    {
      "id": 2,
      "name": "My HTTP Basic Auth key"
    }
  ]
}

Create a key

post

/keys

Creates a key in your keychain.

Use the list of key types API call to get a list of available key types for the typeName parameter. Specify additional parameters in the parameters object based on the key type.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body

teamIdintegerRequired

The ID of the team.

namestringRequired

The name of the key.

typeNamestringRequired

Use the key type to get only keys with the specified type. You can use the API call GET /keys/types to list available key types.

parametersobjectRequired

Additional parameters required to create the key.

Check the list of key types API call for the parameters you need to specify.

Responses

200

Successful response

application/json

post

/keys

POST /api/v2/keys HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "teamId": 22,
  "name": "My HTTP Basic Auth key",
  "typeName": "basicauth",
  "parameters": {
    "authUser": "Martin",
    "authPass": "your-password"
  }
}

200

Successful response

{
  "key": {
    "id": 17,
    "name": "Basic Auth",
    "typeName": "basicauth",
    "teamId": 22,
    "packageName": null,
    "theme": "#007ee5"
  }
}

List key types

get

/keys/types

Gets the list of available key types.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Responses

200

Successful response

application/json

get

/keys/types

GET /api/v2/keys/types HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "keysTypes": [
    {
      "name": "aes-key",
      "label": "AES",
      "parameters": [
        {
          "name": "key",
          "type": "text",
          "label": "Key",
          "required": true
        },
        {
          "name": "keyEncoding",
          "label": "Key Encoding",
          "type": "select",
          "required": true,
          "default": "hex",
          "options": [
            {
              "label": "Base 64",
              "value": "base64"
            },
            {
              "label": "Hexadecimal",
              "value": "hex"
            },
            {
              "label": "Plain Text",
              "value": "plain"
            }
          ]
        }
      ],
      "componentType": "key",
      "author": "Patrik Simek",
      "version": "3.0.12",
      "theme": "#fa6f57",
      "icon": "/img/packages/aes-key.png"
    },
    {
      "name": "apikeyauth",
      "label": "API Key Auth",
      "parameters": [
        {
          "name": "key",
          "label": "Key",
          "type": "password",
          "required": true
        },
        {
          "name": "placement",
          "label": "API Key placement",
          "help": "Define where to place the API Key.",
          "type": "select",
          "required": true,
          "default": "header",
          "options": [
            {
              "label": "In the header",
              "value": "header"
            },
            {
              "label": "In the query string",
              "value": "qs"
            }
          ]
        },
        {
          "name": "name",
          "label": "API Key parameter name",
          "type": "text",
          "default": "X-API-Key",
          "required": true
        }
      ],
      "componentType": "key",
      "author": "Petr Malimanek",
      "version": "3.31.4",
      "theme": "#007ee5",
      "icon": "/img/packages/apikeyauth.png"
    },
    {
      "label": "Apple Push Notifications",
      "name": "apn",
      "parameters": [
        {
          "label": "Private Key",
          "multiline": true,
          "required": true,
          "type": "pkey",
          "name": "privateKey",
          "help": "If you're using Provider Authentication Tokens, insert content of acquired .p8 file."
        },
        {
          "label": "Authentication method",
          "name": "method",
          "type": "select",
          "default": "tokens",
          "options": [
            {
              "label": "Provider Authentication Tokens",
              "value": "tokens",
              "nested": [
                {
                  "label": "Key ID",
                  "required": true,
                  "type": "text",
                  "name": "keyId"
                },
                {
                  "label": "Team ID",
                  "required": true,
                  "type": "text",
                  "name": "teamId"
                }
              ]
            },
            {
              "label": "Certificate",
              "value": "cert",
              "nested": [
                {
                  "label": "Certificate",
                  "required": true,
                  "multiline": true,
                  "type": "cert",
                  "name": "certificate"
                }
              ]
            }
          ]
        },
        {
          "required": true,
          "label": "Production",
          "default": false,
          "name": "production",
          "type": "boolean"
        }
      ],
      "componentType": "key",
      "author": "Patrik Simek",
      "version": "1.1.6",
      "theme": "#666666",
      "icon": "/img/packages/apn.png"
    },
    {
      "name": "basicauth",
      "label": "HTTP Basic Auth",
      "parameters": [
        {
          "name": "authUser",
          "label": "Username",
          "type": "text"
        },
        {
          "name": "authPass",
          "label": "Password",
          "type": "password"
        }
      ],
      "componentType": "key",
      "author": "Petr Malimanek",
      "version": "3.31.4",
      "theme": "#007ee5",
      "icon": "/img/packages/basicauth.png"
    }
  ]
}

Get key details

get

/keys/{keyId}

Gets details of the specified key.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

keyIdintegerRequired

The ID of the key.

Example: 16

Query parameters

Responses

200

Successful response

application/json

get

/keys/{keyId}

GET /api/v2/keys/{keyId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "key": {
    "id": 1,
    "name": "My secret key"
  }
}

Delete a key

delete

/keys/{keyId}

Deletes the specified key. Use the confirmed parameter to confirm deleting the key. Otherwise, you get an error and the key is not deleted.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

keyIdintegerRequired

The ID of the key.

Example: 16

Query parameters

confirmedbooleanOptional

Set this parameter to true to confirm deleting the key. Otherwise, you get an error and the key is not deleted.

Example: true

Responses

200

Successful response

application/json

delete

/keys/{keyId}

DELETE /api/v2/keys/{keyId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "key": 16
}

Update a key

patch

/keys/{keyId}

Updates a key name, connection parameters, or both with the data specified in the request body. If you don't specify a parameter, Make keeps the original value.

Use the GET /key-types API call to find out which parameters you need to specify in the parameters object based on the key type.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

keyIdintegerRequired

The ID of the key.

Example: 16

Body

objectOptional

Responses

200

Successful response

application/json

patch

/keys/{keyId}

PATCH /api/v2/keys/{keyId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "Updated basic auth key"
}

200

Successful response

{
  "key": {
    "id": 16,
    "name": "Updated basic auth key",
    "typeName": "basicauth",
    "teamId": 22,
    "packageName": null,
    "theme": "#007ee5"
  }
}

PreviousHooks > Logs NextNotifications

Last updated 11 days ago

hashtagList keys

hashtagCreate a key

hashtagList key types

hashtagGet key details

hashtagDelete a key

hashtagUpdate a key

List keys

Create a key

List key types

Get key details

Delete a key

Update a key