Skip to main content
POST
/
sessions
/
{session_id}
/
end
cURL
curl --request POST \
  --url https://api.ionq.co/v0.4/sessions/{session_id}/end \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.ionq.co/v0.4/sessions/{session_id}/end"

headers = {"Authorization": "<api-key>"}

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

print(response.text)
const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://api.ionq.co/v0.4/sessions/{session_id}/end', 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://api.ionq.co/v0.4/sessions/{session_id}/end",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.ionq.co/v0.4/sessions/{session_id}/end"

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

req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.ionq.co/v0.4/sessions/{session_id}/end")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ionq.co/v0.4/sessions/{session_id}/end")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "backend": "<string>",
  "project_id": "<string>",
  "creator_id": "<string>",
  "ended_at": "2023-11-07T05:31:56Z",
  "ender_id": "<string>",
  "active": true,
  "started_at": "2023-11-07T05:31:56Z",
  "settings": {
    "job_count_limit": 123,
    "duration_limit_min": 123,
    "cost_limit": {
      "unit": "<string>",
      "value": 123
    },
    "expires_at": "2023-11-07T05:31:56Z"
  }
}
This feature is in beta and only available to select customers today, reach out to [email protected] to request enabling it on your organization.Note: Beta features are subject to change as we gather feedback. Please report any bugs or send feedback to [email protected] or feel free to drop a report in the Community Slack.

Authorizations

Authorization
string
header
required

API keys are associated with a user and can be created on the IonQ Quantum Cloud application. To authenticate, prefix your API Key with apiKey and place it in the Authorization request header. Ex: Authorization: apiKey your-api-key

Path Parameters

session_id
string
required

The id of the session — this id is provided in the response on session creation.

Response

200 - application/json

Successfully end a session.

id
string
required

The id of the session.

created_at
string<date-time>
required
organization_id
string
required
backend
string | null
required
project_id
string | null
required
creator_id
string | null
required
ended_at
string<date-time> | null
required
ender_id
string | null
required
active
boolean
required
status
enum<string>
required
Available options:
created,
started,
ended
started_at
string<date-time> | null
required
settings
object