Send 2FA SMS Code

Sends a 2FA verification code to a phone number via SMS, for SMS 2FA setup or login.

POST /api/v0/tfa/sms

Send 2FA SMS Code

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/tfa/sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "[phone]",
  "tfa_method_id": 3,
  "secret": "abc123secret"
}
'

import requests

url = "https://console.vast.ai/api/v0/tfa/sms"

payload = {
    "phone_number": "[phone]",
    "tfa_method_id": 3,
    "secret": "abc123secret"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phone_number: '[phone]', tfa_method_id: 3, secret: 'abc123secret'})
};

fetch('https://console.vast.ai/api/v0/tfa/sms', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://console.vast.ai/api/v0/tfa/sms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone_number' => '[phone]',
    'tfa_method_id' => 3,
    'secret' => 'abc123secret'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://console.vast.ai/api/v0/tfa/sms"

	payload := strings.NewReader("{\n  \"phone_number\": \"[phone]\",\n  \"tfa_method_id\": 3,\n  \"secret\": \"abc123secret\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://console.vast.ai/api/v0/tfa/sms")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone_number\": \"[phone]\",\n  \"tfa_method_id\": 3,\n  \"secret\": \"abc123secret\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/tfa/sms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone_number\": \"[phone]\",\n  \"tfa_method_id\": 3,\n  \"secret\": \"abc123secret\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "msg": "2FA Sent",
  "secret": "abc123randomtoken"
}

{
  "error": "<string>",
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

phone_number · string

Phone number to send the code to in E.164 format; falls back to the account's registered number if omitted

Example:

"[phone]"

tfa_method_id · integer

ID of an existing SMS 2FA method whose phone number should be used

Example:

3

secret · string

Existing tfa_secret to reuse when refreshing a code during an active login challenge

Example:

"abc123secret"

Response

200

application/json

Returns {msg: "2FA Sent", secret} where secret is used to verify the code.

msg · string

"2FA Sent"

secret · string

TFA secret token to include in the subsequent verification request