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.
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: GET /api/v2/keys HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
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.
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.
POST /api/v2/keys HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 130
{
"teamId": 22,
"name": "My HTTP Basic Auth key",
"typeName": "basicauth",
"parameters": {
"authUser": "Martin",
"authPass": "your-password"
}
}Successful response
{
"key": {
"id": 17,
"name": "Basic Auth",
"typeName": "basicauth",
"teamId": 22,
"packageName": null,
"theme": "#007ee5"
}
}Gets the list of available key types.
GET /api/v2/keys/types HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
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.
The ID of the key.
16GET /api/v2/keys/{keyId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"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.
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.
trueDELETE /api/v2/keys/{keyId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"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.
The ID of the key.
16PATCH /api/v2/keys/{keyId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"name": "Updated basic auth key"
}Successful response
{
"key": {
"id": 16,
"name": "Updated basic auth key",
"typeName": "basicauth",
"teamId": 22,
"packageName": null,
"theme": "#007ee5"
}
}