listProjectKeys

GET 
https://api.pexip.com/v1/projects/:project_id/keys

List a project's keys

Request

Path Parameters

project_id stringrequired

Project ID

Query Parameters

cursor string

Cursor for pagination

Responses

200

Keys

application/json

Schema

Schema

objects object[]required
Array [
id stringrequired
project_id stringrequired
public_key stringrequired
key_type stringrequired
Possible values: [rsa, ec, ed448, ed25519]
fingerprint stringrequired
last_used date-timenullable
use_count integer
created_at date-timerequired
updated_at date-timerequired
]
cursor stringrequired

Cursor for pagination, empty string when no more result

Example (from schema)

{
  "objects": [
    {
      "id": "abcdefghijklmnopqrstuvwxyz",
      "project_id": "abcdefghijklmnopqrstuvwxyz",
      "public_key": "-----BEGIN PUBLIC KEY-----\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC/SZrZ8OIhrpZuc/li7YZO850T\nMpRHXYnlK+pMCFHMPVL3kYRwgwx7DUzqzcgeplC98MDYeT3T6F6pAUCJ8e7YqcUk\nbrWQxBZ883agHZxm9SI8/U9pXL27G5znEvfySyKM5FO0+kgMatvchacnqa9yDgU8\n9bjIg4jV36RbrCfPiwIDAQAB\n-----END PUBLIC KEY-----\n",
      "key_type": "rsa",
      "fingerprint": "SHA256=00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff",
      "last_used": "2024-07-29T15:51:28.071Z",
      "use_count": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "cursor": "bb5h3heefq63m7dayhj5ibuapy"
}

400

Client provided an invalid request

application/json

Schema

Schema

status integerrequired
reason stringrequired
description string
details object
property name* string[]
Array [
string
]

Example (from schema)

{
  "status": 400,
  "reason": "Reason",
  "description": "string",
  "details": {}
}

401

Unauthorized

application/json

Schema

Schema

status integerrequired
reason stringrequired
description string
details object
property name* string[]
Array [
string
]

Example (from schema)

{
  "status": 400,
  "reason": "Reason",
  "description": "string",
  "details": {}
}

403

Forbidden

application/json

Schema

Schema

status integerrequired
reason stringrequired
description string
details object
property name* string[]
Array [
string
]

Example (from schema)

{
  "status": 400,
  "reason": "Reason",
  "description": "string",
  "details": {}
}

404

Resource not found

application/json

Schema

Schema

status integerrequired
reason stringrequired
description string
details object
property name* string[]
Array [
string
]

Example (from schema)

{
  "status": 400,
  "reason": "Reason",
  "description": "string",
  "details": {}
}

Authorization: oauth2

name: oAuthBearertype: oauth2scopes: key:read,key:listflows: {
  "clientCredentials": {
    "tokenUrl": "/oauth/token",
    "scopes": {
      "project:read": "Read project info",
      "project:write": "Update projects",
      "project:create": "Create projects",
      "project:list": "List projects",
      "key:read": "Read key",
      "key:write": "Update keys",
      "key:create": "Create a Key",
      "key:list": "List keys",
      "meeting:read": "Read meeting",
      "meeting:write": "Update meetings",
      "meeting:list": "List meetings",
      "meeting:create": "Create meetings",
      "participant:read": "Read participant info",
      "participant:write": "Update participants",
      "participant:create": "Create participants",
      "participant:list": "List participants"
    }
  }
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.pexip.com/v1/projects/:project_id/keys' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://api.pexip.com

Auth

Bearer Token

Parameters

project_id — pathrequired

cursor — query

ResponseClear

Click the Send API Request button above and see the response here!