Claude Platform Docs

Beta

Models
Union[str, Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]]
One of the following:
class BetaAPIError: …
message: str
defaultInternal server error
type: Literal["api_error"]
defaultapi_error
class BetaAuthenticationError: …
message: str
defaultAuthentication error
type: Literal["authentication_error"]
defaultauthentication_error
class BetaBillingError: …
message: str
defaultBilling error
type: Literal["billing_error"]
defaultbilling_error
Literal["USD"]
BetaError
One of the following:
class BetaErrorResponse: …
error: BetaError
One of the following:
request_id: Optional[str]
type: Literal["error"]
defaulterror
class BetaGatewayTimeoutError: …
message: str
defaultRequest timeout
type: Literal["timeout_error"]
defaulttimeout_error
class BetaInvalidRequestError: …
message: str
defaultInvalid request
type: Literal["invalid_request_error"]
defaultinvalid_request_error
class BetaMonetaryAmount: …

A monetary amount in a specific currency.

amount: str

Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

currency: BetaCurrency

Uppercase ISO-4217 currency code. USD is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

class BetaNotFoundError: …
message: str
defaultNot found
type: Literal["not_found_error"]
defaultnot_found_error
class BetaOverloadedError: …
message: str
defaultOverloaded
type: Literal["overloaded_error"]
defaultoverloaded_error
class BetaPermissionError: …
message: str
defaultPermission denied
type: Literal["permission_error"]
defaultpermission_error
class BetaRateLimitError: …
message: str
defaultRate limited
type: Literal["rate_limit_error"]
defaultrate_limit_error

BetaModels

List Models
beta.models.list(ModelListParams**kwargs) -> SyncPage[BetaModelInfo]
GET/v1/models
Get a Model
beta.models.retrieve(strmodel_id, ModelRetrieveParams**kwargs) -> BetaModelInfo
GET/v1/models/{model_id}

BetaMessages

Create a Message
beta.messages.create(MessageCreateParams**kwargs) -> BetaMessage
POST/v1/messages
Count tokens in a Message
beta.messages.count_tokens(MessageCountTokensParams**kwargs) -> BetaMessageTokensCount
POST/v1/messages/count_tokens

BetaMessagesBatches

Create a Message Batch
beta.messages.batches.create(BatchCreateParams**kwargs) -> BetaMessageBatch
POST/v1/messages/batches
Retrieve a Message Batch
beta.messages.batches.retrieve(strmessage_batch_id, BatchRetrieveParams**kwargs) -> BetaMessageBatch
GET/v1/messages/batches/{message_batch_id}
List Message Batches
beta.messages.batches.list(BatchListParams**kwargs) -> SyncPage[BetaMessageBatch]
GET/v1/messages/batches
Cancel a Message Batch
beta.messages.batches.cancel(strmessage_batch_id, BatchCancelParams**kwargs) -> BetaMessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel
Delete a Message Batch
beta.messages.batches.delete(strmessage_batch_id, BatchDeleteParams**kwargs) -> BetaDeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
beta.messages.batches.results(strmessage_batch_id, BatchResultsParams**kwargs) -> BetaMessageBatchIndividualResponse
GET/v1/messages/batches/{message_batch_id}/results

BetaAgents

Create Agent
beta.agents.create(AgentCreateParams**kwargs) -> BetaManagedAgentsAgent
POST/v1/agents
List Agents
beta.agents.list(AgentListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsAgent]
GET/v1/agents
Get Agent
beta.agents.retrieve(stragent_id, AgentRetrieveParams**kwargs) -> BetaManagedAgentsAgent
GET/v1/agents/{agent_id}
Update Agent
beta.agents.update(stragent_id, AgentUpdateParams**kwargs) -> BetaManagedAgentsAgent
POST/v1/agents/{agent_id}
Archive Agent
beta.agents.archive(stragent_id, AgentArchiveParams**kwargs) -> BetaManagedAgentsAgent
POST/v1/agents/{agent_id}/archive

BetaAgentsVersions

List Agent Versions
beta.agents.versions.list(stragent_id, VersionListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsAgent]
GET/v1/agents/{agent_id}/versions

BetaEnvironments

Create Environment
beta.environments.create(EnvironmentCreateParams**kwargs) -> BetaEnvironment
POST/v1/environments
List Environments
beta.environments.list(EnvironmentListParams**kwargs) -> SyncPageCursor[BetaEnvironment]
GET/v1/environments
Get Environment
beta.environments.retrieve(strenvironment_id, EnvironmentRetrieveParams**kwargs) -> BetaEnvironment
GET/v1/environments/{environment_id}
Update Environment
beta.environments.update(strenvironment_id, EnvironmentUpdateParams**kwargs) -> BetaEnvironment
POST/v1/environments/{environment_id}
Delete Environment
beta.environments.delete(strenvironment_id, EnvironmentDeleteParams**kwargs) -> BetaEnvironmentDeleteResponse
DELETE/v1/environments/{environment_id}
Archive Environment
beta.environments.archive(strenvironment_id, EnvironmentArchiveParams**kwargs) -> BetaEnvironment
POST/v1/environments/{environment_id}/archive

BetaEnvironmentsWork

Get Work Item
beta.environments.work.retrieve(strwork_id, WorkRetrieveParams**kwargs) -> BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/{work_id}
Poll for Work
beta.environments.work.poll(strenvironment_id, WorkPollParams**kwargs) -> BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/poll
Acknowledge Work
beta.environments.work.ack(strwork_id, WorkAckParams**kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/ack
Record Heartbeat
beta.environments.work.heartbeat(strwork_id, WorkHeartbeatParams**kwargs) -> BetaSelfHostedWorkHeartbeatResponse
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Stop Work
beta.environments.work.stop(strwork_id, WorkStopParams**kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/stop
List Work Items
beta.environments.work.list(strenvironment_id, WorkListParams**kwargs) -> SyncPageCursor[BetaSelfHostedWork]
GET/v1/environments/{environment_id}/work
Update Work Item
beta.environments.work.update(strwork_id, WorkUpdateParams**kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}
Get Queue Statistics
beta.environments.work.stats(strenvironment_id, WorkStatsParams**kwargs) -> BetaSelfHostedWorkQueueStats
GET/v1/environments/{environment_id}/work/stats

BetaSessions

Create Session
beta.sessions.create(SessionCreateParams**kwargs) -> BetaManagedAgentsSession
POST/v1/sessions
List Sessions
beta.sessions.list(SessionListParams**kwargs) -> SyncBidirectionalPageCursor[BetaManagedAgentsSession]
GET/v1/sessions
Get Session
beta.sessions.retrieve(strsession_id, SessionRetrieveParams**kwargs) -> BetaManagedAgentsSession
GET/v1/sessions/{session_id}
Update Session
beta.sessions.update(strsession_id, SessionUpdateParams**kwargs) -> BetaManagedAgentsSession
POST/v1/sessions/{session_id}
Delete Session
beta.sessions.delete(strsession_id, SessionDeleteParams**kwargs) -> BetaManagedAgentsDeletedSession
DELETE/v1/sessions/{session_id}
Archive Session
beta.sessions.archive(strsession_id, SessionArchiveParams**kwargs) -> BetaManagedAgentsSession
POST/v1/sessions/{session_id}/archive

BetaSessionsEvents

List Events
beta.sessions.events.list(strsession_id, EventListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsSessionEvent]
GET/v1/sessions/{session_id}/events
Send Events
beta.sessions.events.send(strsession_id, EventSendParams**kwargs) -> BetaManagedAgentsSendSessionEvents
POST/v1/sessions/{session_id}/events
Stream Events
beta.sessions.events.stream(strsession_id, EventStreamParams**kwargs) -> BetaManagedAgentsStreamSessionEvents
GET/v1/sessions/{session_id}/events/stream

BetaSessionsResources

Add Session Resource
beta.sessions.resources.add(strsession_id, ResourceAddParams**kwargs) -> BetaManagedAgentsFileResource
POST/v1/sessions/{session_id}/resources
List Session Resources
beta.sessions.resources.list(strsession_id, ResourceListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsSessionResource]
GET/v1/sessions/{session_id}/resources
Get Session Resource
beta.sessions.resources.retrieve(strresource_id, ResourceRetrieveParams**kwargs) -> ResourceRetrieveResponse
GET/v1/sessions/{session_id}/resources/{resource_id}
Update Session Resource
beta.sessions.resources.update(strresource_id, ResourceUpdateParams**kwargs) -> ResourceUpdateResponse
POST/v1/sessions/{session_id}/resources/{resource_id}
Delete Session Resource
beta.sessions.resources.delete(strresource_id, ResourceDeleteParams**kwargs) -> BetaManagedAgentsDeleteSessionResource
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessionsThreads

List Session Threads
beta.sessions.threads.list(strsession_id, ThreadListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsSessionThread]
GET/v1/sessions/{session_id}/threads
Get Session Thread
beta.sessions.threads.retrieve(strthread_id, ThreadRetrieveParams**kwargs) -> BetaManagedAgentsSessionThread
GET/v1/sessions/{session_id}/threads/{thread_id}
Archive Session Thread
beta.sessions.threads.archive(strthread_id, ThreadArchiveParams**kwargs) -> BetaManagedAgentsSessionThread
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessionsThreadsEvents

List Session Thread Events
beta.sessions.threads.events.list(strthread_id, EventListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsSessionEvent]
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Stream Session Thread Events
beta.sessions.threads.events.stream(strthread_id, EventStreamParams**kwargs) -> BetaManagedAgentsStreamSessionThreadEvents
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployments

Create Deployment
beta.deployments.create(DeploymentCreateParams**kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments
List Deployments
beta.deployments.list(DeploymentListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsDeployment]
GET/v1/deployments
Get Deployment
beta.deployments.retrieve(strdeployment_id, DeploymentRetrieveParams**kwargs) -> BetaManagedAgentsDeployment
GET/v1/deployments/{deployment_id}
Update Deployment
beta.deployments.update(strdeployment_id, DeploymentUpdateParams**kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}
Archive Deployment
beta.deployments.archive(strdeployment_id, DeploymentArchiveParams**kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
beta.deployments.run(strdeployment_id, DeploymentRunParams**kwargs) -> BetaManagedAgentsDeploymentRun
POST/v1/deployments/{deployment_id}/run
Pause Deployment
beta.deployments.pause(strdeployment_id, DeploymentPauseParams**kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
beta.deployments.unpause(strdeployment_id, DeploymentUnpauseParams**kwargs) -> BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/unpause

BetaDeployment Runs

List Deployment Runs
beta.deployment_runs.list(DeploymentRunListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsDeploymentRun]
GET/v1/deployment_runs
Get Deployment Run
beta.deployment_runs.retrieve(strdeployment_run_id, DeploymentRunRetrieveParams**kwargs) -> BetaManagedAgentsDeploymentRun
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Create Vault
beta.vaults.create(VaultCreateParams**kwargs) -> BetaManagedAgentsVault
POST/v1/vaults
List Vaults
beta.vaults.list(VaultListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsVault]
GET/v1/vaults
Get Vault
beta.vaults.retrieve(strvault_id, VaultRetrieveParams**kwargs) -> BetaManagedAgentsVault
GET/v1/vaults/{vault_id}
Update Vault
beta.vaults.update(strvault_id, VaultUpdateParams**kwargs) -> BetaManagedAgentsVault
POST/v1/vaults/{vault_id}
Delete Vault
beta.vaults.delete(strvault_id, VaultDeleteParams**kwargs) -> BetaManagedAgentsDeletedVault
DELETE/v1/vaults/{vault_id}
Archive Vault
beta.vaults.archive(strvault_id, VaultArchiveParams**kwargs) -> BetaManagedAgentsVault
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Create Credential
beta.vaults.credentials.create(strvault_id, CredentialCreateParams**kwargs) -> BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials
List Credentials
beta.vaults.credentials.list(strvault_id, CredentialListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsCredential]
GET/v1/vaults/{vault_id}/credentials
Get Credential
beta.vaults.credentials.retrieve(strcredential_id, CredentialRetrieveParams**kwargs) -> BetaManagedAgentsCredential
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
beta.vaults.credentials.update(strcredential_id, CredentialUpdateParams**kwargs) -> BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
beta.vaults.credentials.delete(strcredential_id, CredentialDeleteParams**kwargs) -> BetaManagedAgentsDeletedCredential
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
beta.vaults.credentials.archive(strcredential_id, CredentialArchiveParams**kwargs) -> BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate Credential
beta.vaults.credentials.mcp_oauth_validate(strcredential_id, CredentialMCPOAuthValidateParams**kwargs) -> BetaManagedAgentsCredentialValidation
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Stores

Create a memory store
beta.memory_stores.create(MemoryStoreCreateParams**kwargs) -> BetaManagedAgentsMemoryStore
POST/v1/memory_stores
List memory stores
beta.memory_stores.list(MemoryStoreListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsMemoryStore]
GET/v1/memory_stores
Retrieve a memory store
beta.memory_stores.retrieve(strmemory_store_id, MemoryStoreRetrieveParams**kwargs) -> BetaManagedAgentsMemoryStore
GET/v1/memory_stores/{memory_store_id}
Update a memory store
beta.memory_stores.update(strmemory_store_id, MemoryStoreUpdateParams**kwargs) -> BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}
Delete a memory store
beta.memory_stores.delete(strmemory_store_id, MemoryStoreDeleteParams**kwargs) -> BetaManagedAgentsDeletedMemoryStore
DELETE/v1/memory_stores/{memory_store_id}
Archive a memory store
beta.memory_stores.archive(strmemory_store_id, MemoryStoreArchiveParams**kwargs) -> BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Create a memory
beta.memory_stores.memories.create(strmemory_store_id, MemoryCreateParams**kwargs) -> BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories
List memories
beta.memory_stores.memories.list(strmemory_store_id, MemoryListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsMemoryListItem]
GET/v1/memory_stores/{memory_store_id}/memories
Retrieve a memory
beta.memory_stores.memories.retrieve(strmemory_id, MemoryRetrieveParams**kwargs) -> BetaManagedAgentsMemory
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Update a memory
beta.memory_stores.memories.update(strmemory_id, MemoryUpdateParams**kwargs) -> BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Delete a memory
beta.memory_stores.memories.delete(strmemory_id, MemoryDeleteParams**kwargs) -> BetaManagedAgentsDeletedMemory
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory Versions

List memory versions
beta.memory_stores.memory_versions.list(strmemory_store_id, MemoryVersionListParams**kwargs) -> SyncPageCursor[BetaManagedAgentsMemoryVersion]
GET/v1/memory_stores/{memory_store_id}/memory_versions
Retrieve a memory version
beta.memory_stores.memory_versions.retrieve(strmemory_version_id, MemoryVersionRetrieveParams**kwargs) -> BetaManagedAgentsMemoryVersion
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Redact a memory version
beta.memory_stores.memory_versions.redact(strmemory_version_id, MemoryVersionRedactParams**kwargs) -> BetaManagedAgentsMemoryVersion
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFiles

Upload File
beta.files.upload(FileUploadParams**kwargs) -> BetaFileMetadata
POST/v1/files
List Files
beta.files.list(FileListParams**kwargs) -> SyncPage[BetaFileMetadata]
GET/v1/files
Download File
beta.files.download(strfile_id, FileDownloadParams**kwargs) -> BinaryResponseContent
GET/v1/files/{file_id}/content
Get File Metadata
beta.files.retrieve_metadata(strfile_id, FileRetrieveMetadataParams**kwargs) -> BetaFileMetadata
GET/v1/files/{file_id}
Delete File
beta.files.delete(strfile_id, FileDeleteParams**kwargs) -> BetaDeletedFile
DELETE/v1/files/{file_id}

BetaSkills

Create Skill
beta.skills.create(SkillCreateParams**kwargs) -> SkillCreateResponse
POST/v1/skills
List Skills
beta.skills.list(SkillListParams**kwargs) -> SyncPageCursor[SkillListResponse]
GET/v1/skills
Get Skill
beta.skills.retrieve(strskill_id, SkillRetrieveParams**kwargs) -> SkillRetrieveResponse
GET/v1/skills/{skill_id}
Delete Skill
beta.skills.delete(strskill_id, SkillDeleteParams**kwargs) -> SkillDeleteResponse
DELETE/v1/skills/{skill_id}

BetaSkillsVersions

Create Skill Version
beta.skills.versions.create(strskill_id, VersionCreateParams**kwargs) -> VersionCreateResponse
POST/v1/skills/{skill_id}/versions
List Skill Versions
beta.skills.versions.list(strskill_id, VersionListParams**kwargs) -> SyncPageCursor[VersionListResponse]
GET/v1/skills/{skill_id}/versions
Download Skill Version Content
beta.skills.versions.download(strversion, VersionDownloadParams**kwargs) -> BinaryResponseContent
GET/v1/skills/{skill_id}/versions/{version}/content
Get Skill Version
beta.skills.versions.retrieve(strversion, VersionRetrieveParams**kwargs) -> VersionRetrieveResponse
GET/v1/skills/{skill_id}/versions/{version}
Delete Skill Version
beta.skills.versions.delete(strversion, VersionDeleteParams**kwargs) -> VersionDeleteResponse
DELETE/v1/skills/{skill_id}/versions/{version}

BetaWebhooks

Unwrap
beta.webhooks.unwrap()

BetaUser Profiles

Create User Profile
beta.user_profiles.create(UserProfileCreateParams**kwargs) -> BetaUserProfile
POST/v1/user_profiles
List User Profiles
beta.user_profiles.list(UserProfileListParams**kwargs) -> SyncPageCursor[BetaUserProfile]
GET/v1/user_profiles
Get User Profile
beta.user_profiles.retrieve(struser_profile_id, UserProfileRetrieveParams**kwargs) -> BetaUserProfile
GET/v1/user_profiles/{user_profile_id}
Update User Profile
beta.user_profiles.update(struser_profile_id, UserProfileUpdateParams**kwargs) -> BetaUserProfile
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
beta.user_profiles.create_enrollment_url(struser_profile_id, UserProfileCreateEnrollmentURLParams**kwargs) -> BetaUserProfileEnrollmentURL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Create a Dream
beta.dreams.create(DreamCreateParams**kwargs) -> BetaDream
POST/v1/dreams
List Dreams
beta.dreams.list(DreamListParams**kwargs) -> SyncPageCursor[BetaDream]
GET/v1/dreams
Get a Dream
beta.dreams.retrieve(strdream_id, DreamRetrieveParams**kwargs) -> BetaDream
GET/v1/dreams/{dream_id}
Cancel a Dream
beta.dreams.cancel(strdream_id, DreamCancelParams**kwargs) -> BetaDream
POST/v1/dreams/{dream_id}/cancel
Archive a Dream
beta.dreams.archive(strdream_id, DreamArchiveParams**kwargs) -> BetaDream
POST/v1/dreams/{dream_id}/archive

BetaTunnels

Create Tunnel
beta.tunnels.create(TunnelCreateParams**kwargs) -> BetaTunnel
POST/v1/tunnels
Get Tunnel
beta.tunnels.retrieve(strtunnel_id, TunnelRetrieveParams**kwargs) -> BetaTunnel
GET/v1/tunnels/{tunnel_id}
List Tunnels
beta.tunnels.list(TunnelListParams**kwargs) -> SyncPageCursor[BetaTunnel]
GET/v1/tunnels
Archive Tunnel
beta.tunnels.archive(strtunnel_id, TunnelArchiveParams**kwargs) -> BetaTunnel
POST/v1/tunnels/{tunnel_id}/archive
Reveal Tunnel Token
beta.tunnels.reveal_token(strtunnel_id, TunnelRevealTokenParams**kwargs) -> BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotate Tunnel Token
beta.tunnels.rotate_token(strtunnel_id, TunnelRotateTokenParams**kwargs) -> BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelsCertificates

Create Tunnel Certificate
beta.tunnels.certificates.create(strtunnel_id, CertificateCreateParams**kwargs) -> BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates
Get Tunnel Certificate
beta.tunnels.certificates.retrieve(strcertificate_id, CertificateRetrieveParams**kwargs) -> BetaTunnelCertificate
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
List Tunnel Certificates
beta.tunnels.certificates.list(strtunnel_id, CertificateListParams**kwargs) -> SyncPageCursor[BetaTunnelCertificate]
GET/v1/tunnels/{tunnel_id}/certificates
Archive Tunnel Certificate
beta.tunnels.certificates.archive(strcertificate_id, CertificateArchiveParams**kwargs) -> BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganization

Get Current Organization
beta.organization.retrieve() -> BetaOrganization
GET/v1/organizations/me

BetaOrganizationAPI Keys

List API Keys
beta.organization.api_keys.list(APIKeyListParams**kwargs) -> SyncPage[BetaAPIKey]
GET/v1/organizations/api_keys
Get API Key
beta.organization.api_keys.retrieve(strapi_key_id) -> BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}
Update API Key
beta.organization.api_keys.update(strapi_key_id, APIKeyUpdateParams**kwargs) -> BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizationExternal Keys

Create External Key
beta.organization.external_keys.create(ExternalKeyCreateParams**kwargs) -> BetaExternalKey
POST/v1/organizations/external_keys
List External Keys
beta.organization.external_keys.list(ExternalKeyListParams**kwargs) -> SyncPageCursor[BetaExternalKey]
GET/v1/organizations/external_keys
Get External Key
beta.organization.external_keys.retrieve(strexternal_key_id) -> BetaExternalKey
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
beta.organization.external_keys.update(strexternal_key_id, ExternalKeyUpdateParams**kwargs) -> BetaExternalKey
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
beta.organization.external_keys.delete(strexternal_key_id) -> ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
beta.organization.external_keys.validate(strexternal_key_id) -> ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizationFederationIssuers

Create Federation Issuer
beta.organization.federation.issuers.create(IssuerCreateParams**kwargs) -> BetaFederationIssuer
POST/v1/organizations/federation_issuers
List Federation Issuers
beta.organization.federation.issuers.list(IssuerListParams**kwargs) -> SyncPageCursor[BetaFederationIssuer]
GET/v1/organizations/federation_issuers
Get Federation Issuer
beta.organization.federation.issuers.retrieve(strfederation_issuer_id, IssuerRetrieveParams**kwargs) -> BetaFederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Update Federation Issuer
beta.organization.federation.issuers.update(strfederation_issuer_id, IssuerUpdateParams**kwargs) -> BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archive Federation Issuer
beta.organization.federation.issuers.archive(strfederation_issuer_id, IssuerArchiveParams**kwargs) -> BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizationFederationRules

Create Federation Rule
beta.organization.federation.rules.create(RuleCreateParams**kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules
List Federation Rules
beta.organization.federation.rules.list(RuleListParams**kwargs) -> SyncPageCursor[BetaFederationRule]
GET/v1/organizations/federation_rules
Get Federation Rule
beta.organization.federation.rules.retrieve(strfederation_rule_id, RuleRetrieveParams**kwargs) -> BetaFederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}
Update Federation Rule
beta.organization.federation.rules.update(strfederation_rule_id, RuleUpdateParams**kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}
Archive Federation Rule
beta.organization.federation.rules.archive(strfederation_rule_id, RuleArchiveParams**kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
beta.organization.federation.rules.workspaces.add(strfederation_rule_id, WorkspaceAddParams**kwargs) -> BetaFederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
List Federation Rule Workspaces
beta.organization.federation.rules.workspaces.list(strfederation_rule_id, WorkspaceListParams**kwargs) -> SyncPageCursor[BetaFederationRuleWorkspace]
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remove Federation Rule Workspace
beta.organization.federation.rules.workspaces.remove(strworkspace_id, WorkspaceRemoveParams**kwargs) -> WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizationInvites

Create Invite
beta.organization.invites.create(InviteCreateParams**kwargs) -> BetaOrganizationInvite
POST/v1/organizations/invites
List Invites
beta.organization.invites.list(InviteListParams**kwargs) -> SyncPage[BetaOrganizationInvite]
GET/v1/organizations/invites
Get Invite
beta.organization.invites.retrieve(strinvite_id) -> BetaOrganizationInvite
GET/v1/organizations/invites/{invite_id}
Delete Invite
beta.organization.invites.delete(strinvite_id) -> InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizationService Accounts

Create Service Account
beta.organization.service_accounts.create(ServiceAccountCreateParams**kwargs) -> BetaServiceAccount
POST/v1/organizations/service_accounts
List Service Accounts
beta.organization.service_accounts.list(ServiceAccountListParams**kwargs) -> SyncPageCursor[BetaServiceAccount]
GET/v1/organizations/service_accounts
Get Service Account
beta.organization.service_accounts.retrieve(strservice_account_id, ServiceAccountRetrieveParams**kwargs) -> BetaServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}
Update Service Account
beta.organization.service_accounts.update(strservice_account_id, ServiceAccountUpdateParams**kwargs) -> BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}
Archive Service Account
beta.organization.service_accounts.archive(strservice_account_id, ServiceAccountArchiveParams**kwargs) -> BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizationService AccountsWorkspaces

Add Workspace To Service Account
beta.organization.service_accounts.workspaces.add(strservice_account_id, WorkspaceAddParams**kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
List Workspaces For Service Account
beta.organization.service_accounts.workspaces.list(strservice_account_id, WorkspaceListParams**kwargs) -> SyncPageCursor[BetaServiceAccountWorkspaceMember]
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remove Workspace From Service Account
beta.organization.service_accounts.workspaces.remove(strworkspace_id, WorkspaceRemoveParams**kwargs) -> WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizationUsers

List Users
beta.organization.users.list(UserListParams**kwargs) -> SyncPage[BetaOrganizationUser]
GET/v1/organizations/users
Get User
beta.organization.users.retrieve(struser_id) -> BetaOrganizationUser
GET/v1/organizations/users/{user_id}
Update User
beta.organization.users.update(struser_id, UserUpdateParams**kwargs) -> BetaOrganizationUser
POST/v1/organizations/users/{user_id}
Remove User
beta.organization.users.remove(struser_id) -> UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

BetaOrganizationWorkspaces

List Workspaces
beta.organization.workspaces.list(WorkspaceListParams**kwargs) -> SyncPage[BetaWorkspace]
GET/v1/organizations/workspaces
Create Workspace
beta.organization.workspaces.create(WorkspaceCreateParams**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces
Get Workspace
beta.organization.workspaces.retrieve(strworkspace_id) -> BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
beta.organization.workspaces.update(strworkspace_id, WorkspaceUpdateParams**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
beta.organization.workspaces.archive(strworkspace_id) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizationWorkspacesRate Limits

List Workspace Rate Limits
beta.organization.workspaces.rate_limits.list(strworkspace_id, RateLimitListParams**kwargs) -> SyncPageCursor[BetaWorkspaceRateLimit]
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganizationWorkspacesMembers

List Workspace Members
beta.organization.workspaces.members.list(strworkspace_id, MemberListParams**kwargs) -> SyncPage[BetaWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
beta.organization.workspaces.members.add(strworkspace_id, MemberAddParams**kwargs) -> BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
beta.organization.workspaces.members.retrieve(struser_id, MemberRetrieveParams**kwargs) -> BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
beta.organization.workspaces.members.update(struser_id, MemberUpdateParams**kwargs) -> BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
beta.organization.workspaces.members.remove(struser_id, MemberRemoveParams**kwargs) -> MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizationWorkspacesService Accounts

List Service Account Workspace Members
beta.organization.workspaces.service_accounts.list(strworkspace_id, ServiceAccountListParams**kwargs) -> SyncPageCursor[BetaServiceAccountWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Create Service Account Workspace Member
beta.organization.workspaces.service_accounts.add(strworkspace_id, ServiceAccountAddParams**kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
beta.organization.workspaces.service_accounts.retrieve(strservice_account_id, ServiceAccountRetrieveParams**kwargs) -> BetaServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
beta.organization.workspaces.service_accounts.update(strservice_account_id, ServiceAccountUpdateParams**kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
beta.organization.workspaces.service_accounts.remove(strservice_account_id, ServiceAccountRemoveParams**kwargs) -> ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizationRate Limits

List Organization Rate Limits
beta.organization.rate_limits.list(RateLimitListParams**kwargs) -> SyncPageCursor[BetaOrganizationRateLimit]
GET/v1/organizations/rate_limits