qcs_api_client_openapi/apis/

endpoints_api.rs

// Copyright 2026 Rigetti Computing
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/*
 * Rigetti QCS API
 *
 * # Introduction  This is the documentation for the Rigetti QCS HTTP API.  You can find out more about Rigetti at [https://rigetti.com](https://rigetti.com), and also interact with QCS via the web at [https://qcs.rigetti.com](https://qcs.rigetti.com).  This API is documented in **OpenAPI format** and so is compatible with the dozens of language-specific client generators available [here](https://github.com/OpenAPITools/openapi-generator) and elsewhere on the web.  # Principles  This API follows REST design principles where appropriate, and otherwise an HTTP RPC paradigm. We adhere to the Google [API Improvement Proposals](https://google.aip.dev/general) where reasonable to provide a consistent, intuitive developer experience. HTTP response codes match their specifications, and error messages fit a common format.  # Authentication  All access to the QCS API requires OAuth2 authentication provided by Okta. You can request access [here](https://www.rigetti.com/get-quantum). Once you have a user account, you can download your access token from QCS [here](https://qcs.rigetti.com/auth/token).   That access token is valid for 24 hours after issuance. The value of `access_token` within the JSON file is the token used for authentication (don't use the entire JSON file).  Authenticate requests using the `Authorization` header and a `Bearer` prefix:  ``` curl --header \"Authorization: Bearer eyJraW...Iow\" ```  # Quantum Processor Access  Access to the quantum processors themselves is not yet provided directly by this HTTP API, but is instead performed over ZeroMQ/[rpcq](https://github.com/rigetti/rpcq). Until that changes, we suggest using [pyquil](https://github.com/rigetti/pyquil) to build and execute quantum programs via the Legacy API.  # Legacy API  Our legacy HTTP API remains accessible at https://forest-server.qcs.rigetti.com, and it shares a source of truth with this API's services. You can use either service with the same user account and means of authentication. We strongly recommend using the API documented here, as the legacy API is on the path to deprecation.
 *
 * The version of the OpenAPI document: 2020-07-31
 * Contact: support@rigetti.com
 * Generated by: https://openapi-generator.tech
 */

use super::{ContentType, Error, configuration};
use crate::{apis::ResponseContent, models};
use ::qcs_api_client_common::backoff::{
    BackoffBuilder, ExponentialBackoff, duration_from_io_error, duration_from_reqwest_error,
    duration_from_response,
};
#[cfg(feature = "tracing")]
use qcs_api_client_common::configuration::tokens::TokenRefresher;
use qcs_dependencies_client::reqwest::{self, StatusCode};
use serde::{Deserialize, Serialize};

#[cfg(feature = "clap")]
#[allow(unused, reason = "not used in all templates, but required in some")]
use ::{miette::IntoDiagnostic as _, qcs_api_client_common::clap_utils::JsonMaybeStdin};

/// Serialize command-line arguments for [`create_endpoint`]
#[cfg(feature = "clap")]
#[derive(Debug, clap::Args)]
pub struct CreateEndpointClapParams {
    pub create_endpoint_parameters: JsonMaybeStdin<crate::models::CreateEndpointParameters>,
}

#[cfg(feature = "clap")]
impl CreateEndpointClapParams {
    pub async fn execute(
        self,
        configuration: &configuration::Configuration,
    ) -> Result<models::Endpoint, miette::Error> {
        let request = self.create_endpoint_parameters.into_inner().into_inner();

        create_endpoint(configuration, request)
            .await
            .into_diagnostic()
    }
}

/// Serialize command-line arguments for [`list_endpoints`]
#[cfg(feature = "clap")]
#[derive(Debug, clap::Args)]
pub struct ListEndpointsClapParams {
    /// Filtering logic specified using [rule-engine](https://zerosteiner.github.io/rule-engine/syntax.html) grammar
    #[arg(long)]
    pub filter: Option<String>,
    #[arg(long)]
    pub page_size: Option<i64>,
    #[arg(long)]
    pub page_token: Option<String>,
}

#[cfg(feature = "clap")]
impl ListEndpointsClapParams {
    pub async fn execute(
        self,
        configuration: &configuration::Configuration,
    ) -> Result<models::ListEndpointsResponse, miette::Error> {
        list_endpoints(
            configuration,
            self.filter.as_deref(),
            self.page_size,
            self.page_token.as_deref(),
        )
        .await
        .into_diagnostic()
    }
}

/// Serialize command-line arguments for [`restart_endpoint`]
#[cfg(feature = "clap")]
#[derive(Debug, clap::Args)]
pub struct RestartEndpointClapParams {
    #[arg(long)]
    pub endpoint_id: String,
    pub restart_endpoint_request: Option<JsonMaybeStdin<crate::models::RestartEndpointRequest>>,
}

#[cfg(feature = "clap")]
impl RestartEndpointClapParams {
    pub async fn execute(
        self,
        configuration: &configuration::Configuration,
    ) -> Result<(), miette::Error> {
        let request = self
            .restart_endpoint_request
            .map(|body| body.into_inner().into_inner());

        restart_endpoint(configuration, self.endpoint_id.as_str(), request)
            .await
            .into_diagnostic()
    }
}

/// struct for typed errors of method [`create_endpoint`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum CreateEndpointError {
    Status400(models::Error),
    Status404(models::Error),
    Status422(models::ValidationError),
    UnknownValue(serde_json::Value),
}

/// struct for typed errors of method [`list_endpoints`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListEndpointsError {
    Status422(models::ValidationError),
    UnknownValue(serde_json::Value),
}

/// struct for typed errors of method [`restart_endpoint`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum RestartEndpointError {
    Status403(models::Error),
    Status422(models::ValidationError),
    UnknownValue(serde_json::Value),
}

async fn create_endpoint_inner(
    configuration: &configuration::Configuration,
    backoff: &mut ExponentialBackoff,
    create_endpoint_parameters: crate::models::CreateEndpointParameters,
) -> Result<models::Endpoint, Error<CreateEndpointError>> {
    let local_var_configuration = configuration;
    // add a prefix to parameters to efficiently prevent name collisions
    let p_body_create_endpoint_parameters = create_endpoint_parameters;

    let local_var_client = &local_var_configuration.client;

    let local_var_uri_str = format!(
        "{}/v1/endpoints",
        local_var_configuration.qcs_config.api_url()
    );
    let mut local_var_req_builder =
        local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());

    #[cfg(feature = "tracing")]
    {
        // Ignore parsing errors if the URL is invalid for some reason.
        // If it is invalid, it will turn up as an error later when actually making the request.
        let local_var_do_tracing = local_var_uri_str
            .parse::<::url::Url>()
            .ok()
            .is_none_or(|url| {
                configuration
                    .qcs_config
                    .should_trace(&::urlpattern::UrlPatternMatchInput::Url(url))
            });

        if local_var_do_tracing {
            ::tracing::debug!(
                url=%local_var_uri_str,
                method="POST",
                "making create_endpoint request",
            );
        }
    }

    // Use the QCS Bearer token if a client OAuthSession is present,
    // but do not require one when the security schema says it is optional.
    {
        use qcs_api_client_common::configuration::TokenError;

        #[allow(
            clippy::nonminimal_bool,
            clippy::eq_op,
            reason = "Logic must be done at runtime since it cannot be handled by the mustache template engine."
        )]
        let is_jwt_bearer_optional: bool = false || "JWTBearer" == "JWTBearerOptional";

        let token = local_var_configuration
            .qcs_config
            .get_bearer_access_token()
            .await;

        if is_jwt_bearer_optional && matches!(token, Err(TokenError::NoCredentials)) {
            // the client is configured without any OAuthSession, but this call does not require one.
            #[cfg(feature = "tracing")]
            tracing::debug!(
                "No client credentials found, but this call does not require authentication."
            );
        } else {
            local_var_req_builder = local_var_req_builder.bearer_auth(token?.secret());
        }
    }

    local_var_req_builder = local_var_req_builder.json(&p_body_create_endpoint_parameters);

    let local_var_req = local_var_req_builder.build()?;
    let local_var_resp = local_var_client.execute(local_var_req).await?;

    let local_var_status = local_var_resp.status();
    let local_var_raw_content_type = local_var_resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream")
        .to_string();
    let local_var_content_type = super::ContentType::from(local_var_raw_content_type.as_str());

    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
        let local_var_content = local_var_resp.text().await?;
        match local_var_content_type {
            ContentType::Json => serde_path_to_error::deserialize(
                &mut serde_json::Deserializer::from_str(&local_var_content),
            )
            .map_err(Error::from),
            ContentType::Text => Err(Error::InvalidContentType {
                content_type: local_var_raw_content_type,
                return_type: "models::Endpoint",
            }),
            ContentType::Unsupported(unknown_type) => Err(Error::InvalidContentType {
                content_type: unknown_type,
                return_type: "models::Endpoint",
            }),
        }
    } else {
        let local_var_retry_delay =
            duration_from_response(local_var_resp.status(), local_var_resp.headers(), backoff);
        let local_var_content = local_var_resp.text().await?;
        let local_var_entity: Option<CreateEndpointError> =
            serde_json::from_str(&local_var_content).ok();
        let local_var_error = ResponseContent {
            status: local_var_status,
            content: local_var_content,
            entity: local_var_entity,
            retry_delay: local_var_retry_delay,
        };
        Err(Error::ResponseError(local_var_error))
    }
}

/// Create an endpoint associated with your user account.
pub async fn create_endpoint(
    configuration: &configuration::Configuration,
    create_endpoint_parameters: crate::models::CreateEndpointParameters,
) -> Result<models::Endpoint, Error<CreateEndpointError>> {
    let mut backoff = configuration.backoff.build();
    let mut refreshed_credentials = false;
    let method = reqwest::Method::POST;
    loop {
        let result = create_endpoint_inner(
            configuration,
            &mut backoff,
            create_endpoint_parameters.clone(),
        )
        .await;

        match result {
            Ok(result) => return Ok(result),
            Err(Error::ResponseError(response)) => {
                if !refreshed_credentials
                    && matches!(
                        response.status,
                        StatusCode::FORBIDDEN | StatusCode::UNAUTHORIZED
                    )
                {
                    // Attempt to refresh credentials
                    match configuration.qcs_config.refresh().await {
                        Ok(_) => {
                            refreshed_credentials = true;
                            continue;
                        }
                        Err(::qcs_api_client_common::configuration::TokenError::Write {
                            error,
                            oauth_session: _,
                        }) => {
                            // Token refresh succeeded but persistence failed
                            // The token is already in memory and will be used for this request
                            #[cfg(feature = "tracing")]
                            tracing::warn!(
                                "Token refresh succeeded but failed to persist: {}. Continuing with in-memory token.",
                                error
                            );
                            refreshed_credentials = true;
                            continue;
                        }
                        Err(e) => return Err(e.into()),
                    }
                } else if let Some(duration) = response.retry_delay {
                    tokio::time::sleep(duration).await;
                    continue;
                }

                return Err(Error::ResponseError(response));
            }
            Err(Error::Reqwest(error)) => {
                if let Some(duration) = duration_from_reqwest_error(&method, &error, &mut backoff) {
                    tokio::time::sleep(duration).await;
                    continue;
                }

                return Err(Error::Reqwest(error));
            }
            Err(Error::Io(error)) => {
                if let Some(duration) = duration_from_io_error(&method, &error, &mut backoff) {
                    tokio::time::sleep(duration).await;
                    continue;
                }

                return Err(Error::Io(error));
            }
            Err(error) => return Err(error),
        }
    }
}
async fn list_endpoints_inner(
    configuration: &configuration::Configuration,
    backoff: &mut ExponentialBackoff,
    filter: Option<&str>,
    page_size: Option<i64>,
    page_token: Option<&str>,
) -> Result<models::ListEndpointsResponse, Error<ListEndpointsError>> {
    let local_var_configuration = configuration;
    // add a prefix to parameters to efficiently prevent name collisions
    let p_query_filter = filter;
    let p_query_page_size = page_size;
    let p_query_page_token = page_token;

    let local_var_client = &local_var_configuration.client;

    let local_var_uri_str = format!(
        "{}/v1/endpoints",
        local_var_configuration.qcs_config.api_url()
    );
    let mut local_var_req_builder =
        local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());

    #[cfg(feature = "tracing")]
    {
        // Ignore parsing errors if the URL is invalid for some reason.
        // If it is invalid, it will turn up as an error later when actually making the request.
        let local_var_do_tracing = local_var_uri_str
            .parse::<::url::Url>()
            .ok()
            .is_none_or(|url| {
                configuration
                    .qcs_config
                    .should_trace(&::urlpattern::UrlPatternMatchInput::Url(url))
            });

        if local_var_do_tracing {
            ::tracing::debug!(
                url=%local_var_uri_str,
                method="GET",
                "making list_endpoints request",
            );
        }
    }

    if let Some(ref local_var_str) = p_query_filter {
        local_var_req_builder =
            local_var_req_builder.query(&[("filter", &local_var_str.to_string())]);
    }
    if let Some(ref local_var_str) = p_query_page_size {
        local_var_req_builder =
            local_var_req_builder.query(&[("pageSize", &local_var_str.to_string())]);
    }
    if let Some(ref local_var_str) = p_query_page_token {
        local_var_req_builder =
            local_var_req_builder.query(&[("pageToken", &local_var_str.to_string())]);
    }

    // Use the QCS Bearer token if a client OAuthSession is present,
    // but do not require one when the security schema says it is optional.
    {
        use qcs_api_client_common::configuration::TokenError;

        #[allow(
            clippy::nonminimal_bool,
            clippy::eq_op,
            reason = "Logic must be done at runtime since it cannot be handled by the mustache template engine."
        )]
        let is_jwt_bearer_optional: bool = false || "JWTBearer" == "JWTBearerOptional";

        let token = local_var_configuration
            .qcs_config
            .get_bearer_access_token()
            .await;

        if is_jwt_bearer_optional && matches!(token, Err(TokenError::NoCredentials)) {
            // the client is configured without any OAuthSession, but this call does not require one.
            #[cfg(feature = "tracing")]
            tracing::debug!(
                "No client credentials found, but this call does not require authentication."
            );
        } else {
            local_var_req_builder = local_var_req_builder.bearer_auth(token?.secret());
        }
    }

    let local_var_req = local_var_req_builder.build()?;
    let local_var_resp = local_var_client.execute(local_var_req).await?;

    let local_var_status = local_var_resp.status();
    let local_var_raw_content_type = local_var_resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream")
        .to_string();
    let local_var_content_type = super::ContentType::from(local_var_raw_content_type.as_str());

    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
        let local_var_content = local_var_resp.text().await?;
        match local_var_content_type {
            ContentType::Json => serde_path_to_error::deserialize(
                &mut serde_json::Deserializer::from_str(&local_var_content),
            )
            .map_err(Error::from),
            ContentType::Text => Err(Error::InvalidContentType {
                content_type: local_var_raw_content_type,
                return_type: "models::ListEndpointsResponse",
            }),
            ContentType::Unsupported(unknown_type) => Err(Error::InvalidContentType {
                content_type: unknown_type,
                return_type: "models::ListEndpointsResponse",
            }),
        }
    } else {
        let local_var_retry_delay =
            duration_from_response(local_var_resp.status(), local_var_resp.headers(), backoff);
        let local_var_content = local_var_resp.text().await?;
        let local_var_entity: Option<ListEndpointsError> =
            serde_json::from_str(&local_var_content).ok();
        let local_var_error = ResponseContent {
            status: local_var_status,
            content: local_var_content,
            entity: local_var_entity,
            retry_delay: local_var_retry_delay,
        };
        Err(Error::ResponseError(local_var_error))
    }
}

/// List all endpoints, optionally filtering by attribute.
pub async fn list_endpoints(
    configuration: &configuration::Configuration,
    filter: Option<&str>,
    page_size: Option<i64>,
    page_token: Option<&str>,
) -> Result<models::ListEndpointsResponse, Error<ListEndpointsError>> {
    let mut backoff = configuration.backoff.build();
    let mut refreshed_credentials = false;
    let method = reqwest::Method::GET;
    loop {
        let result = list_endpoints_inner(
            configuration,
            &mut backoff,
            filter.clone(),
            page_size.clone(),
            page_token.clone(),
        )
        .await;

        match result {
            Ok(result) => return Ok(result),
            Err(Error::ResponseError(response)) => {
                if !refreshed_credentials
                    && matches!(
                        response.status,
                        StatusCode::FORBIDDEN | StatusCode::UNAUTHORIZED
                    )
                {
                    // Attempt to refresh credentials
                    match configuration.qcs_config.refresh().await {
                        Ok(_) => {
                            refreshed_credentials = true;
                            continue;
                        }
                        Err(::qcs_api_client_common::configuration::TokenError::Write {
                            error,
                            oauth_session: _,
                        }) => {
                            // Token refresh succeeded but persistence failed
                            // The token is already in memory and will be used for this request
                            #[cfg(feature = "tracing")]
                            tracing::warn!(
                                "Token refresh succeeded but failed to persist: {}. Continuing with in-memory token.",
                                error
                            );
                            refreshed_credentials = true;
                            continue;
                        }
                        Err(e) => return Err(e.into()),
                    }
                } else if let Some(duration) = response.retry_delay {
                    tokio::time::sleep(duration).await;
                    continue;
                }

                return Err(Error::ResponseError(response));
            }
            Err(Error::Reqwest(error)) => {
                if let Some(duration) = duration_from_reqwest_error(&method, &error, &mut backoff) {
                    tokio::time::sleep(duration).await;
                    continue;
                }

                return Err(Error::Reqwest(error));
            }
            Err(Error::Io(error)) => {
                if let Some(duration) = duration_from_io_error(&method, &error, &mut backoff) {
                    tokio::time::sleep(duration).await;
                    continue;
                }

                return Err(Error::Io(error));
            }
            Err(error) => return Err(error),
        }
    }
}
async fn restart_endpoint_inner(
    configuration: &configuration::Configuration,
    backoff: &mut ExponentialBackoff,
    endpoint_id: &str,
    restart_endpoint_request: Option<crate::models::RestartEndpointRequest>,
) -> Result<(), Error<RestartEndpointError>> {
    let local_var_configuration = configuration;
    // add a prefix to parameters to efficiently prevent name collisions
    let p_path_endpoint_id = endpoint_id;
    let p_body_restart_endpoint_request = restart_endpoint_request;

    let local_var_client = &local_var_configuration.client;

    let local_var_uri_str = format!(
        "{}/v1/endpoints/{endpointId}:restart",
        local_var_configuration.qcs_config.api_url(),
        endpointId = crate::apis::urlencode(p_path_endpoint_id)
    );
    let mut local_var_req_builder =
        local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());

    #[cfg(feature = "tracing")]
    {
        // Ignore parsing errors if the URL is invalid for some reason.
        // If it is invalid, it will turn up as an error later when actually making the request.
        let local_var_do_tracing = local_var_uri_str
            .parse::<::url::Url>()
            .ok()
            .is_none_or(|url| {
                configuration
                    .qcs_config
                    .should_trace(&::urlpattern::UrlPatternMatchInput::Url(url))
            });

        if local_var_do_tracing {
            ::tracing::debug!(
                url=%local_var_uri_str,
                method="POST",
                "making restart_endpoint request",
            );
        }
    }

    // Use the QCS Bearer token if a client OAuthSession is present,
    // but do not require one when the security schema says it is optional.
    {
        use qcs_api_client_common::configuration::TokenError;

        #[allow(
            clippy::nonminimal_bool,
            clippy::eq_op,
            reason = "Logic must be done at runtime since it cannot be handled by the mustache template engine."
        )]
        let is_jwt_bearer_optional: bool = false || "JWTBearer" == "JWTBearerOptional";

        let token = local_var_configuration
            .qcs_config
            .get_bearer_access_token()
            .await;

        if is_jwt_bearer_optional && matches!(token, Err(TokenError::NoCredentials)) {
            // the client is configured without any OAuthSession, but this call does not require one.
            #[cfg(feature = "tracing")]
            tracing::debug!(
                "No client credentials found, but this call does not require authentication."
            );
        } else {
            local_var_req_builder = local_var_req_builder.bearer_auth(token?.secret());
        }
    }

    local_var_req_builder = local_var_req_builder.json(&p_body_restart_endpoint_request);

    let local_var_req = local_var_req_builder.build()?;
    let local_var_resp = local_var_client.execute(local_var_req).await?;

    let local_var_status = local_var_resp.status();

    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
        Ok(())
    } else {
        let local_var_retry_delay =
            duration_from_response(local_var_resp.status(), local_var_resp.headers(), backoff);
        let local_var_content = local_var_resp.text().await?;
        let local_var_entity: Option<RestartEndpointError> =
            serde_json::from_str(&local_var_content).ok();
        let local_var_error = ResponseContent {
            status: local_var_status,
            content: local_var_content,
            entity: local_var_entity,
            retry_delay: local_var_retry_delay,
        };
        Err(Error::ResponseError(local_var_error))
    }
}

/// Restart an entire endpoint or a single component within an endpoint.
pub async fn restart_endpoint(
    configuration: &configuration::Configuration,
    endpoint_id: &str,
    restart_endpoint_request: Option<crate::models::RestartEndpointRequest>,
) -> Result<(), Error<RestartEndpointError>> {
    let mut backoff = configuration.backoff.build();
    let mut refreshed_credentials = false;
    let method = reqwest::Method::POST;
    loop {
        let result = restart_endpoint_inner(
            configuration,
            &mut backoff,
            endpoint_id.clone(),
            restart_endpoint_request.clone(),
        )
        .await;

        match result {
            Ok(result) => return Ok(result),
            Err(Error::ResponseError(response)) => {
                if !refreshed_credentials
                    && matches!(
                        response.status,
                        StatusCode::FORBIDDEN | StatusCode::UNAUTHORIZED
                    )
                {
                    // Attempt to refresh credentials
                    match configuration.qcs_config.refresh().await {
                        Ok(_) => {
                            refreshed_credentials = true;
                            continue;
                        }
                        Err(::qcs_api_client_common::configuration::TokenError::Write {
                            error,
                            oauth_session: _,
                        }) => {
                            // Token refresh succeeded but persistence failed
                            // The token is already in memory and will be used for this request
                            #[cfg(feature = "tracing")]
                            tracing::warn!(
                                "Token refresh succeeded but failed to persist: {}. Continuing with in-memory token.",
                                error
                            );
                            refreshed_credentials = true;
                            continue;
                        }
                        Err(e) => return Err(e.into()),
                    }
                } else if let Some(duration) = response.retry_delay {
                    tokio::time::sleep(duration).await;
                    continue;
                }

                return Err(Error::ResponseError(response));
            }
            Err(Error::Reqwest(error)) => {
                if let Some(duration) = duration_from_reqwest_error(&method, &error, &mut backoff) {
                    tokio::time::sleep(duration).await;
                    continue;
                }

                return Err(Error::Reqwest(error));
            }
            Err(Error::Io(error)) => {
                if let Some(duration) = duration_from_io_error(&method, &error, &mut backoff) {
                    tokio::time::sleep(duration).await;
                    continue;
                }

                return Err(Error::Io(error));
            }
            Err(error) => return Err(error),
        }
    }
}