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.
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.
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.
The ID of the team.
22Use 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.
basicauthPossible values: Successful response
GET /api/v2/keys?teamId=1 HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*
Successful response
{
"keys": [
{
"id": 1,
"name": "My HTTP Basic Auth key"
},
{
"id": 2,
"name": "My HTTP Basic Auth key"
}
]
}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.
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.
The ID of the team.
The name of the key.
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.
Additional parameters required to create the key.
Check the list of key types API call for the parameters you need to specify.
Entity-tier visibility of the created key. With locked the key is restricted to its access list from the moment it is created, with the creator as its sole admin. Requires the Locked connections feature to be enabled for the organization; otherwise the request fails with IM903 (HTTP 400). When the access list cannot be provisioned, the request fails with HTTP 422 and the key is not created. Omitted or team, the key is visible to the whole team.
teamPossible values: Successful response
The visibility value is invalid (IM005), or visibility: locked was sent while the Locked connections feature is not enabled for the organization (IM903, returned while the web_api_locked_connections feature flag is off).
The access list of a locked key could not be provisioned (IM016). The key is not created — the request can be retried.
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"
}
}{
"key": {
"id": 17,
"name": "Basic Auth",
"typeName": "basicauth",
"teamId": 22,
"packageName": null,
"theme": "#007ee5"
}
}Gets the list of available key types.
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.
Successful response
GET /api/v2/keys/types HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*
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"
}
]
}Gets details of the specified key.
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.
The ID of the key.
16Successful response
The key is restricted to its access list and the caller is not on it with permission to use it (IM002).
GET /api/v2/keys/{keyId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*
{
"key": {
"id": 1,
"name": "My secret key"
}
}Deletes the specified key. Use the confirmed parameter to confirm deleting the key. Otherwise, you get an error and the key is not deleted.
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.
The ID of the key.
16Set this parameter to true to confirm deleting the key. Otherwise, you get an error and the key is not deleted.
trueSuccessful response
The key is restricted to its access list and the caller is not on it with permission to manage it (IM002). A team administrator may still delete such a key only when nobody is left able to manage it.
DELETE /api/v2/keys/{keyId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*
{
"key": 16
}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.
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.
The ID of the key.
16Successful response
The key is restricted to its access list and the caller is not on it with permission to manage it (IM002).
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"
}{
"key": {
"id": 16,
"name": "Updated basic auth key",
"typeName": "basicauth",
"teamId": 22,
"packageName": null,
"theme": "#007ee5"
}
}Restricts the key's visibility to its access list (visibility: locked). The caller becomes the sole admin of the locked key.
Caller rule: only the key's author can lock it. A key without an author cannot be locked.
The operation is idempotent — locking an already locked key succeeds without any change; the caller rule above still applies.
Requires the Locked connections feature to be enabled for the organization.
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.
The ID of the key.
16Successful response
The Locked connections feature is not enabled for the organization (IM903, returned while the web_api_locked_connections feature flag is off).
The caller is not the key's author (IM002).
The key does not exist (IM013).
The key has no author (SC409) — locking is reserved to the key's author.
POST /api/v2/keys/{keyId}/make-locked HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*
{
"key": {
"id": 8,
"visibility": "locked"
}
}Makes a locked key visible to the whole team again (visibility: team) and clears the key's entire access list. Only an admin of the locked key can perform the flip. The key's author is not changed.
The operation is idempotent — flipping an already team-visible key succeeds, provided the caller has the key edit permission; any residual entries on the key's access list are still cleared.
Requires the Locked connections feature to be enabled for the organization.
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.
The ID of the key.
16Successful response
The Locked connections feature is not enabled for the organization (IM903, returned while the web_api_locked_connections feature flag is off).
The caller is not an admin of the locked key (IM002).
The key does not exist (IM013).
POST /api/v2/keys/{keyId}/make-team HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*
{
"key": {
"id": 8,
"visibility": "team"
}
}Last updated