Teampass API documentation

Keys¶

Getting a single key¶

You can view a single key by executing the following request:

[GET] /api/v1/key/{id}

Response¶

STATUS: 200 OK

{
    "id": "1",
    "title": "second key",
    "type": "PASSWORD",
    "folder": "2",
    "url": "https://pass.securium.ch",
    "password": "ZGVtbw==",
    "username": "ZGVtby5tYW5hZ2Vy",
    "email": "demo@pass.securium.ch",
    "description": ""
}

Create a key¶

To create a new key, you can execute the following request:

[POST] /api/v1/key

Parameters¶

title: title for key
folder: folder id
username: username, base64 encode string
password: passwords, base64 encode string
email: email
url: url
description: description for key

Response¶

STATUS: 201 CREATED

{
    "id": "2",
    "title": "first key",
    "type": "PASSWORD",
    "folder": "1",
    "url": "https://pass.securium.ch",
    "password": "ZGVtbw==",
    "username": "ZGVtby51c2Vy",
    "email": "demo@pass.securium.ch",
    "description": ""
}

Updating a key¶

You can update an existing key using PUT:

[PUT] /api/key/{id}

Parameters¶

title: title for key
folder: folder id
username: username, base64 encode string
password: passwords, base64 encode string
email: email
url: url
description: description for key

Response¶

STATUS: 200 OK

{
    "id": "2",
    "title": "rename first key",
    "type": "PASSWORD",
    "folder": "1",
    "url": "https://pass.securium.ch",
    "password": "ZGVtbw==",
    "username": "ZGVtby51c2Vy",
    "email": "demo@pass.securium.ch",
    "description": ""
}

Deleting a key¶

You can delete a key from the system by making the following DELETE call:

[DELETE] /api/key/{id}

Response¶

STATUS: 204 NO CONTENT