Sftp Users

Get SFTP user

get

https://canvas.instructure.com

/accounts/{account_id}/sftp_user

Retrieves SFTP user information for an account

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Path parameters

account_idintegerRequired

Responses

200

SFTP user found

application/json

idintegerOptional

usernamestringOptional

account_idintegerOptional

public_keysstring[]Optional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

401

Unauthorized

404

SFTP user not found

get

/accounts/{account_id}/sftp_user

HTTPcURLJavaScriptPython

GET /accounts/{account_id}/sftp_user HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "username": "text",
  "account_id": 1,
  "public_keys": [
    "text"
  ],
  "created_at": "2026-03-06T20:00:53.869Z",
  "updated_at": "2026-03-06T20:00:53.869Z"
}

Create SFTP user

post

https://canvas.instructure.com

/accounts/{account_id}/sftp_user

Creates an SFTP user for an account

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Path parameters

account_idintegerRequired

Body

application/json

usernamestringRequired

Responses

201

SFTP user created

401

Unauthorized

post

/accounts/{account_id}/sftp_user

HTTPcURLJavaScriptPython

POST /accounts/{account_id}/sftp_user HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "username": "text"
}

No content

Add SSH key

post

https://canvas.instructure.com

/accounts/{account_id}/sftp_user/keys/add

Adds an SSH public key to the SFTP user

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Path parameters

account_idintegerRequired

Body

application/json

public_keystringRequired

SSH public key in OpenSSH format

Responses

200

Key added

No content

400

Invalid key format

401

Unauthorized

post

/accounts/{account_id}/sftp_user/keys/add

HTTPcURLJavaScriptPython

POST /accounts/{account_id}/sftp_user/keys/add HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "public_key": "text"
}

No content

Delete SSH key

delete

https://canvas.instructure.com

/accounts/{account_id}/sftp_user/keys/delete

Removes an SSH public key from the SFTP user

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

Canvas API access token

Path parameters

account_idintegerRequired

Body

application/json

public_keystringRequired

Responses

204

Key deleted

401

Unauthorized

delete

/accounts/{account_id}/sftp_user/keys/delete

HTTPcURLJavaScriptPython

DELETE /accounts/{account_id}/sftp_user/keys/delete HTTP/1.1
Host: canvas.instructure.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "public_key": "text"
}

No content