From 6c3136c81150c9f96123a406c08cac474a4cc28b Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 2 Jan 2025 04:21:59 +0000 Subject: [PATCH] Documentation autoupdate --- html/rest_api_doc.html | 840 ++++---- html/site/sitemap.xml | 50 +- html/site/sitemap.xml.gz | Bin 345 -> 345 bytes yaml/rest_api_doc_spec.yaml | 3682 +++++++++++++++++------------------ 4 files changed, 2286 insertions(+), 2286 deletions(-) diff --git a/html/rest_api_doc.html b/html/rest_api_doc.html index 1e828f243e..fdb6f18f8d 100644 --- a/html/rest_api_doc.html +++ b/html/rest_api_doc.html @@ -426,7 +426,7 @@ -
Rucio logo
API docs by Redocly
Rucio logo
API docs by Redocly
Error handling " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not Acceptable

Request samples 

curl --request GET \
   --url http://undefinedundefined/accounts/{account}/limits/global/{rse_expression} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Delete identity

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

List identities

Lists all identities for an account.

+
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/accounts/{account}/identities \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • [
    ]
]

Delete identity

Delete an account identity.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -682,7 +696,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "identity": "string",
  • "authtype": "string"
}

Create identity

Request samples

Content type
application/json
{
  • "identity": "string",
  • "authtype": "string"
}

Create identity

Grant an account identity access to an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -706,21 +720,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Account not found

Request samples

Content type
application/json
{
  • "identity": "string",
  • "authtype": "string",
  • "email": "string",
  • "password": "none",
  • "default": false
}

Response samples

Content type
application/json
"Created"

List identities

Lists all identities for an account.

-
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/accounts/{account}/identities \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • [
    ]
]

List rules

Request samples

Content type
application/json
{
  • "identity": "string",
  • "authtype": "string",
  • "email": "string",
  • "password": "none",
  • "default": false
}

Response samples

Content type
application/json
"Created"

List rules

Lists all rules for an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -782,7 +782,21 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

curl --request GET \
   --url http://undefinedundefined/accounts/{account}/usage/global/{rse_expression} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Delete

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

List account parameters

Lists all parameters for an account.

+
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/accounts/{account} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "account": "string",
  • "account_type": "string",
  • "status": "string",
  • "email": "string",
  • "suspended_at": "string",
  • "deleted_at": "string"
}

Delete

Delete an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -792,53 +806,39 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples 

curl --request DELETE \
+

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/accounts/{account} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create

Create an account.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update

Update a parameter for an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-
Request Body schema: application/json
type
required
string
Enum: "USER" "GROUP" "SERVICE"

The account type.

-
email
required
string

The email for the account.

-

Responses

Request samples

Content type
application/json
{
  • "type": "USER",
  • "email": "string"
}

Response samples

Content type
application/json
"Created"

List account parameters

Lists all parameters for an account.

-
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/accounts/{account} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "account": "string",
  • "account_type": "string",
  • "status": "string",
  • "email": "string",
  • "suspended_at": "string",
  • "deleted_at": "string"
}

Update

Update a parameter for an account.

+

Request samples

Content type
application/json
{ }

Create

Create an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-
Request Body schema: application/json
object

Json object with key-value pairs corresponding to the new values of the parameters.

-

Responses

Request samples

Content type
application/json
{ }

List

409

Account already exists

+

Request samples

Content type
application/json
{
  • "type": "USER",
  • "email": "string"
}

Response samples

Content type
application/json
"Created"

List

List all accounts.

Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
   --url http://undefinedundefined/accounts \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Auth

UserPass Allow cross-site scripting

UserPass Allow cross-site scripting. Explicit for Authentication.

-
Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/userpass \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

UserPass

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Auth

UserPass

Authenticate a Rucio account temporarily via username and password.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string

Account identifier as a string.

@@ -872,42 +864,42 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Partial content containing X-Rucio-Auth-Accounts header

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/userpass \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
   --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' \
   --header 'X-Rucio-Password: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Username: SOME_STRING_VALUE'

GSS Allow cross-site scripting

GSS Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Username: SOME_STRING_VALUE'

UserPass Allow cross-site scripting

UserPass Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/gss \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

GSS

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/userpass \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

GSS

Authenticate a Rucio account via GSS.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string
REMOTE_USER
required
string
X-Rucio-AppID
string
X-Forwarded-For
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/gss \
   --header 'REMOTE_USER: SOME_STRING_VALUE' \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

x509 Allow cross-site scripting

x509 Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

GSS Allow cross-site scripting

GSS Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/x509 \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

x509

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/gss \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

x509

Authenticate a Rucio account via x509.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string
X-Rucio-AppID
string
X-Forwarded-For
string
X-Rucio-Allow-Return-Multiple-Accounts
boolean

If set to true, a HTTP 206 response will be returned if the identity is associated with multiple accounts.

@@ -917,104 +909,104 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Partial content containing X-Rucio-Auth-Accounts header

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/x509 \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-Allow-Return-Multiple-Accounts: SOME_BOOLEAN_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SSH Allow cross-site scripting

SSH Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

x509 Allow cross-site scripting

x509 Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/ssh \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SSH

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/x509 \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SSH

Authenticate a Rucio account via SSH.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string
X-Rucio-SSH-Signature
required
string
X-Rucio-AppID
string
X-Forwarded-For
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/ssh \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
   --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' \
-  --header 'X-Rucio-SSH-Signature: SOME_STRING_VALUE'

SSHChallengeToken Allow cross-site scripting

SSHChallengeToken Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-SSH-Signature: SOME_STRING_VALUE'

SSH Allow cross-site scripting

SSH Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/ssh_challenge_token \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SSHChallengeToken

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/ssh \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SSHChallengeToken

Authenticate a Rucio account via SSHChallengeToken.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string
X-Rucio-AppID
string
X-Forwarded-For
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/ssh_challenge_token \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SAML Allow cross-site scripting

SAML Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SSHChallengeToken Allow cross-site scripting

SSHChallengeToken Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/saml \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Post a SAML request

Post a SAML request

-
Authorizations:
AuthToken

Responses

Request samples 

curl --request POST \
-  --url http://undefinedundefined/auth/saml \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SAML

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/ssh_challenge_token \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SAML

Authenticate a Rucio account via SAML.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string
X-Rucio-AppID
string
X-Forwarded-For
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/saml \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Validate Allow cross-site scripting

Validate Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SAML Allow cross-site scripting

SAML Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/validate \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Validate

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/saml \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Post a SAML request

Post a SAML request

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request POST \
+  --url http://undefinedundefined/auth/saml \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Validate

Validate a Rucio auth token.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/validate \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

OIDC Allow cross-site scripting

OIDC Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Validate Allow cross-site scripting

Validate Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

OIDC

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/validate \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

OIDC

Authenticate a Rucio account via OIDC.

Authorizations:
AuthToken
header Parameters
HTTP_X_RUCIO_ACCOUNT
string

Account identifier as a string.

@@ -1022,7 +1014,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

OK

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/oidc \
   --header 'HTTP_X_RUCIO_ACCOUNT: SOME_STRING_VALUE' \
   --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_AUDIENCE: SOME_STRING_VALUE' \
@@ -1032,49 +1024,49 @@ 
Error handling

   --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_REFRESH_LIFETIME: SOME_STRING_VALUE' \
   --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_SCOPE: SOME_STRING_VALUE' \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

TokenOIDC Allow cross-site scripting

TokenOIDC Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

OIDC Allow cross-site scripting

OIDC Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc_token \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

TokenOIDC

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

TokenOIDC

Authenticate a Rucio account via TokenOIDC.

Authorizations:
AuthToken
header Parameters
X-Forwarded-For
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/oidc_token \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

CodeOIDC Allow cross-site scripting

CodeOIDC Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

TokenOIDC Allow cross-site scripting

TokenOIDC Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc_code \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

CodeOIDC

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc_token \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

CodeOIDC

Authenticate a Rucio account via CodeOIDC.

Authorizations:
AuthToken
header Parameters
X-Forwarded-For
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/oidc_code \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

RedirectOIDC Allow cross-site scripting

RedirectOIDC Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

CodeOIDC Allow cross-site scripting

CodeOIDC Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc_redirect \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

RedirectOIDC

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc_code \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

RedirectOIDC

Authenticate a Rucio account via RedirectOIDC.

Authorizations:
AuthToken
header Parameters
X-Rucio-Client-Fetch-Token
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/oidc_redirect \
   --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' \
-  --header 'X-Rucio-Client-Fetch-Token: SOME_STRING_VALUE'

RefreshOIDC Allow cross-site scripting

RefreshOIDC Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Client-Fetch-Token: SOME_STRING_VALUE'

RedirectOIDC Allow cross-site scripting

RedirectOIDC Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc_refresh \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

RefreshOIDC

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc_redirect \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

RefreshOIDC

Authenticate a Rucio account via RefreshOIDC.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string
X-Rucio-Auth-Token
required
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/oidc_refresh \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

RefreshOIDC Allow cross-site scripting

RefreshOIDC Allow cross-site scripting. Explicit for Authentication.

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc_refresh \
   --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Config

Create value

Create or set the value of an option.

Authorizations:
AuthToken
path Parameters
section
required
string
Error handling " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Value could not be set

Request samples 

curl --request PUT \
   --url http://undefinedundefined/config/{section}/{option}/{value} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Created"

Delete option

Delete an option of a section.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Created"

Get option

Returns the value of an option

Authorizations:
AuthToken
path Parameters
section
required
string

The section.

option
required
string

The option of the section.

-

Responses

Request samples 

curl --request DELETE \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/config/{section}/{option} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Get option

Returns the value of an option

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"string"

Delete option

Delete an option of a section.

Authorizations:
AuthToken
path Parameters
section
required
string

The section.

option
required
string

The option of the section.

-

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/config/{section}/{option} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"string"

List Sections

Authorizations:
AuthToken
path Parameters
section
required
string
--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

List Sections

Authorizations:
AuthToken
path Parameters
section
required
string

The section to return.

Request Body schema: application/json
bytes
required
integer

The new limit in bytes.

@@ -1158,7 +1158,17 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Config not found

Request samples

Content type
application/json
{
  • "bytes": 0
}

Response samples

Content type
application/json
{ }

Create

Request samples

Content type
application/json
{
  • "bytes": 0
}

Response samples

Content type
application/json
{ }

List

List the full configuration.

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/config \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Create

Create or set the configuration option in the requested section.

Authorizations:
AuthToken
Request Body schema: application/json
object

The request body is expected to contain a json {'section': {'option': 'value'}}.

@@ -1170,25 +1180,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"Created"

List

List the full configuration.

-
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/config \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Credentials

Cross-Site Scripting

Allow cross-site scripting. Explicit for Authentication.

-
Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
-  --url http://undefinedundefined/credentials/signurl \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Sign URL

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"Created"

Credentials

Sign URL

Sign a url for a limited lifetime for a particular srevice.

Authorizations:
AuthToken
query Parameters
rse
required
string

The RSE to authenticate against.

@@ -1214,9 +1206,17 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url 'http://undefinedundefined/credentials/signurl?rse=SOME_STRING_VALUE&lifetime=SOME_STRING_VALUE&svc=SOME_STRING_VALUE&op=SOME_STRING_VALUE&url=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Data Identifiers

Get Data Identifier

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Cross-Site Scripting

Allow cross-site scripting. Explicit for Authentication.

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/credentials/signurl \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Data Identifiers

Get Data Identifier

Return all data identifiers in the given scope.

Authorizations:
AuthToken
path Parameters
scope
required
string

The scope.

@@ -1332,7 +1332,21 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

curl --request GET \
   --url http://undefinedundefined/dids/{scope_name}/dids/history \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Detach dids from did

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Get did

Returns the contents of a data identifier.

+
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/dids/{scope_name}/dids \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Detach dids from did

Detach data identifiers from data identifiers.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

@@ -1344,7 +1358,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "dids": [
    ]
}

Add dids to did

Request samples

Content type
application/json
{
  • "dids": [
    ]
}

Add dids to did

Append data identifiers to data identifiers.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

@@ -1364,21 +1378,25 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples

Content type
application/json
{
  • "rse": "string",
  • "account": "string",
  • "dids": {
    }
}

Response samples

Content type
application/json
"Created"

Get did

Returns the contents of a data identifier.

+

Request samples

Content type
application/json
{
  • "rse": "string",
  • "account": "string",
  • "dids": {
    }
}

Response samples

Content type
application/json
"Created"

Get metadata

Get the metadata of a did.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

-

Responses

query Parameters
plugin
string
Default: "DID_COLUMN"

The plugin to use.

+

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/dids/{scope_name}/dids \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Delete metadata

Request samples 

curl --request GET \
+  --url 'http://undefinedundefined/dids/{scope_name}/meta?plugin=SOME_STRING_VALUE' \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Delete metadata

Deletes the specified metadata from the did.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

@@ -1396,9 +1414,9 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

curl --request DELETE \
+

Request samples 

curl --request DELETE \
   --url 'http://undefinedundefined/dids/{scope_name}/meta?key=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Add metadata

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Add metadata

Add metadata to a did.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

@@ -1414,25 +1432,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not found

Request samples

Content type
application/json
{
  • "meta": { },
  • "recursive": false
}

Response samples

Content type
application/json
"Created"

Get metadata

Get the metadata of a did.

-
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

-
query Parameters
plugin
string
Default: "DID_COLUMN"

The plugin to use.

-

Responses

Request samples 

curl --request GET \
-  --url 'http://undefinedundefined/dids/{scope_name}/meta?plugin=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Add metadata

Request samples

Content type
application/json
{
  • "meta": { },
  • "recursive": false
}

Response samples

Content type
application/json
"Created"

Add metadata

Add metadata to a did.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

@@ -1508,7 +1508,23 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

curl --request GET \
   --url http://undefinedundefined/dids/{scope_name}/associated_rules \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Delete follow

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Get followers

Get all followers for a specific did.

+
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/dids/{scope_name}/follow \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Delete follow

Mark the input DID as not followed

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

@@ -1522,7 +1538,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not found

Request samples

Content type
application/json
{
  • "account": "string"
}

Post follow

Request samples

Content type
application/json
{
  • "account": "string"
}

Post follow

Mark the input DID as being followed by the given account.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

@@ -1538,23 +1554,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not found

Request samples

Content type
application/json
{
  • "account": "string"
}

Get followers

Get all followers for a specific did.

-
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/dids/{scope_name}/follow \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Add Dids bulk

Request samples

Content type
application/json
{
  • "account": "string"
}

Add Dids bulk

Add new Dids in bulk.

Authorizations:
AuthToken
Request Body schema: application/json
Array
scope
required
string

The did scope.

@@ -1750,7 +1750,17 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

curl --request GET \
   --url 'http://undefinedundefined/export?distance=SOME_BOOLEAN_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Heartbeat

Create

Authorizations:
AuthToken
Request Body schema: application/json
executable
string
--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Heartbeat

List

List all heartbeats.

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/heartbeats \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • { }
]

Create

Authorizations:
AuthToken
Request Body schema: application/json
executable
string

Name of the executable.

hostname
string

Name of the host.

@@ -1768,17 +1778,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "executable": "string",
  • "hostname": "string",
  • "pid": 0,
  • "older_than": 0,
  • "payload": "string"
}

List

List all heartbeats.

-
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/heartbeats \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • { }
]

Identity

Create UserPass identity

Request samples

Content type
application/json
{
  • "executable": "string",
  • "hostname": "string",
  • "pid": 0,
  • "older_than": 0,
  • "payload": "string"
}

Identity

Create UserPass identity

Creates a new UserPass identity and maps it to an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the identity.

@@ -1844,7 +1844,19 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

OK

Request samples

Content type
application/json
{
  • "rses": {
    },
  • "distances": {
    },
  • "accounts": [
    ]
}

Response samples

Content type
application/json
"Created"

Lifetime Exceptions

Create Exception

Request samples

Content type
application/json
{
  • "rses": {
    },
  • "distances": {
    },
  • "accounts": [
    ]
}

Response samples

Content type
application/json
"Created"

Lifetime Exceptions

List Exceptions

Retrieves all exceptions.

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/lifetime_exceptions/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Create Exception

Creates a Lifetime Exception.

Authorizations:
AuthToken
Request Body schema: application/json
Array of objects

List of dids associated with the lifetime exception.

@@ -1858,23 +1870,11 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

OK

Request samples

Content type
application/json
{
  • "dids": [
    ],
  • "pattern": "string",
  • "comments": "string",
  • "expires_at": "string"
}

Response samples

Content type
application/json
"string"

List Exceptions

Retrieves all exceptions.

-
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/lifetime_exceptions/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Get Exception

401

Invalid Auth Token

+

Request samples

Content type
application/json
{
  • "dids": [
    ],
  • "pattern": "string",
  • "comments": "string",
  • "expires_at": "string"
}

Response samples

Content type
application/json
"string"

Get Exception

Get a single Lifetime Exception.

Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the lifetime exception.

@@ -1960,7 +1960,19 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token.

Request samples

Content type
application/json
{
  • "key_type": "string",
  • "value_type": "string",
  • "value_regexp": "string"
}

Response samples

Content type
application/json
"Created"

Create value for key

Request samples

Content type
application/json
{
  • "key_type": "string",
  • "value_type": "string",
  • "value_regexp": "string"
}

Response samples

Content type
application/json
"Created"

Get value for key

List all values for a key.

+
Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/meta_conventions/{key}/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • "string"
]

Create value for key

Creates a new value for a key.

Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

@@ -1976,19 +1988,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Key not found

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Get value for key

List all values for a key.

-
Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/meta_conventions/{key}/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • "string"
]

Create key

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Create key

Creates a new allowed key (value is NULL).

Authorizations:
AuthToken
path Parameters
key
required
string

The name of the key.

@@ -2006,7 +2006,19 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token.

Request samples

Content type
application/json
{
  • "key_type": "string",
  • "value_type": "string",
  • "value_regexp": "string"
}

Response samples

Content type
application/json
"Created"

Create value for key

Request samples

Content type
application/json
{
  • "key_type": "string",
  • "value_type": "string",
  • "value_regexp": "string"
}

Response samples

Content type
application/json
"Created"

Get value for key

List all values for a key.

+
Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/meta/{key}/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • "string"
]

Create value for key

Creates a new value for a key.

Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

@@ -2022,19 +2034,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Key not found

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Get value for key

List all values for a key.

-
Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/meta/{key}/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • "string"
]

Ping

Ping

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Ping

Ping

Ping the server and get data about it.

Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
   --url 'http://undefinedundefined/replicas/{scope_name}?schemes=SOME_STRING_VALUE&select=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE' \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Declare Suspicious Replicas

Declare a list of suspicious replicas.

-
Authorizations:
AuthToken
Request Body schema: application/json
pfns
Array of strings

The list of pfns.

-
reason
string

The reason for the declaration.

-

Responses

Request samples

Content type
application/json
{
  • "pfns": [
    ],
  • "reason": "string"
}

Response samples

Content type
application/json
[ ]

List Suspicious Replicas

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

List Suspicious Replicas

List the suspicious replicas on a list of RSEs.

Authorizations:
AuthToken
query Parameters
rse_expression
string

The RSE expression to filter for.

@@ -2175,9 +2161,23 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not found

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url 'http://undefinedundefined/replicas/suspicious?rse_expression=SOME_STRING_VALUE&younger_than=SOME_STRING_VALUE&nattempts=SOME_INTEGER_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

List Bad Replicas By States

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Declare Suspicious Replicas

Declare a list of suspicious replicas.

+
Authorizations:
AuthToken
Request Body schema: application/json
pfns
Array of strings

The list of pfns.

+
reason
string

The reason for the declaration.

+

Responses

Request samples

Content type
application/json
{
  • "pfns": [
    ],
  • "reason": "string"
}

Response samples

Content type
application/json
[ ]

List Bad Replicas By States

List the bad or suspicious replicas by states.

Authorizations:
AuthToken
query Parameters
state
string
Enum: "SUSPICIOUS" "BAD"

The state of the file.

@@ -2419,25 +2419,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

curl --request GET \
   --url 'http://undefinedundefined/subscriptions/{account}/{name}/rules?state=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • null
]

Create subscription

Create a new subscription

-
Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

-
name
required
string

The subscription name.

-
Request Body schema: application/json
required
object

The values for the new subscription.

-

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
"string"

Get Subscription

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • null
]

Get Subscription

Retrieve a subscription.

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

@@ -2451,9 +2433,9 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Subscription Not found

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/subscriptions/{account}/{name} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Update subscription

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Update subscription

Update an existing subscription.

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

@@ -2469,7 +2451,25 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "options": {
    }
}

Get Subscription by Name

Request samples

Content type
application/json
{
  • "options": {
    }
}

Create subscription

Create a new subscription

+
Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

+
name
required
string

The subscription name.

+
Request Body schema: application/json
required
object

The values for the new subscription.

+

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
"string"

Get Subscription by Name

Retrieve a subscription by name.

Authorizations:
AuthToken
path Parameters
name
required
string

The subscription name.

@@ -2611,8 +2611,8 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

RSE not found

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Delete Rse Distance

Delete distance information between source RSE and destination RSE.

+

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Get Rse Distances

Returns the distances between a source and destination rse.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

destination
required
string
Error handling " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Rse not found

Request samples 

curl --request DELETE \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/rses/{source}/distances/{destination} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Deleted"

Create Rse Distance

Post a rse distance.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Delete Rse Distance

Delete distance information between source RSE and destination RSE.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

destination
required
string

The name of the destination Rucio Storage Element.

-
Request Body schema: application/json
distance
integer

The distance between RSEs.

-
ranking
integer
Deprecated

Same as distance.

-

Responses

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Get Rse Distances

Returns the distances between a source and destination rse.

+

Request samples 

curl --request DELETE \
+  --url http://undefinedundefined/rses/{source}/distances/{destination} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Deleted"

Update Rse Distance

Update rse distance information.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

destination
required
string

The name of the destination Rucio Storage Element.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/rses/{source}/distances/{destination} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Update Rse Distance

Update rse distance information.

+

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Create Rse Distance

Post a rse distance.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

destination
required
string

The name of the destination Rucio Storage Element.

-
Request Body schema: application/json
distance
integer

The distance between the RSEs.

+
Request Body schema: application/json
distance
integer

The distance between RSEs.

ranking
integer
Deprecated

Same as distance.

Responses

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Delete Protocol Attributes

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Delete Protocol Attributes

Delete all protocol attributes.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2821,13 +2821,11 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

curl --request GET \
   --url http://undefinedundefined/rses/{rse}/usage/history \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Delete Rse Limit

Delete an rse limit

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Get Rse Limits

Get the rse limits.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
Request Body schema: application/json
name
required
string

The name of the limit.

-

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Get Rse Limits

Get the rse limits.

+

Request samples 

curl --request GET \
+  --url http://undefinedundefined/rses/{rse}/limits \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "limit name1": 0,
  • "limit name2": 0
}

Delete Rse Limit

Delete an rse limit

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/rses/{rse}/limits \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "limit name1": 0,
  • "limit name2": 0
}

Update Rse Limit

Request samples

Content type
application/json
{
  • "name": "string"
}

Update Rse Limit

Update an rse limit.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2897,7 +2897,21 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

curl --request POST \
   --url http://undefinedundefined/rses/{rse}/qos_policy/{policy} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Created"

Disable RSE

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Created"

Get RSE

Get details about a specific RSE.

+
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/rses/{rse} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": 0,
  • "availability_write": 0,
  • "availability_delete": null
}

Disable RSE

Disable a specific RSE.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2907,13 +2921,19 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples 

curl --request DELETE \
+

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/rses/{rse} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create RSE

Creates a RSE with all the metadata.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update RSE

Update RSE properties.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
Request Body schema: application/json
deterministic
boolean
Request Body schema: application/json
availability_read
boolean

The vailability of the RSE.

+
availability_write
boolean

The vailability of the RSE.

+
availability_delete
boolean

The vailability of the RSE.

+
deterministic
boolean

If the pfn is generated deterministicly.

volatile
boolean

RSE cache.

@@ -2925,63 +2945,27 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs">

The region code of the RSE.

country_name
string

The country name of the RSE.

-
continent
string

The continent of the RSE.

time_zone
string

The time zone of the RSE.

-
ISP
string

The internet service provider of the RSE.

rse_type
string
Enum: "DISK" "TAPE"

The rse type.

latitude
number

The latitude of the RSE.

-
longitude
number
longitude
number

The longitude of the RSE.

-
ASN
string

The access service network of the RSE.

-
availability
integer
Deprecated

The availability of the RSE.

-
availability_read
boolean

If the RSE is readable.

-
availability_write
boolean

If the RSE is writable.

-
availability_delete
boolean

If the RSE is deletable.

Responses

Request samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true
}

Response samples

Content type
application/json
"Created"

Get RSE

Get details about a specific RSE.

-
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/rses/{rse} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": 0,
  • "availability_write": 0,
  • "availability_delete": null
}

Update RSE

Update RSE properties.

+

Request samples

Content type
application/json
{
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "time_zone": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
"Created"

Create RSE

Creates a RSE with all the metadata.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
Request Body schema: application/json
availability_read
boolean

The vailability of the RSE.

-
availability_write
boolean

The vailability of the RSE.

-
availability_delete
boolean

The vailability of the RSE.

-
deterministic
boolean
Request Body schema: application/json
deterministic
boolean

If the pfn is generated deterministicly.

volatile
boolean

RSE cache.

@@ -2993,23 +2977,39 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs">

The region code of the RSE.

country_name
string

The country name of the RSE.

+
continent
string

The continent of the RSE.

time_zone
string

The time zone of the RSE.

+
ISP
string

The internet service provider of the RSE.

rse_type
string
Enum: "DISK" "TAPE"

The rse type.

latitude
number

The latitude of the RSE.

-
longitude
number
longitude
number

The longitude of the RSE.

+
ASN
string

The access service network of the RSE.

+
availability
integer
Deprecated

The availability of the RSE.

+
availability_read
boolean

If the RSE is readable.

+
availability_write
boolean

If the RSE is writable.

+
availability_delete
boolean

If the RSE is deletable.

Responses

Request samples

Content type
application/json
{
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "time_zone": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
"Created"

List RSEs

409

RSE already exists.

+

Request samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true
}

Response samples

Content type
application/json
"Created"

List RSEs

Lists all RSEs.

Authorizations:
AuthToken
query Parameters
expression
string

RSE expression to select RSEs.

@@ -3023,29 +3023,29 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

curl --request GET \
   --url 'http://undefinedundefined/rses/?expression=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Rule

Delete a replication rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string
--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Rule

Return a Rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

-

Responses

Request samples 

curl --request DELETE \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/rules/{rule_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Return a Rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string
--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"string"

Delete a replication rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

-

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/rules/{rule_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"string"

Update the replication rules parameters

Authorizations:
AuthToken
path Parameters
rule_id
required
string
--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update the replication rules parameters

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

Request Body schema: application/json

Parameters for the new rule.

@@ -3057,7 +3057,17 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "options": {
    }
}

Create a new replication rule

Authorizations:
AuthToken
Request Body schema: application/json

Request samples

Content type
application/json
{
  • "options": {
    }
}

Return all rules for a given account

Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/rules/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"string"

Create a new replication rule

Authorizations:
AuthToken
Request Body schema: application/json

Parameters for the new rule.

required
Array of objects

The list of data identifiers.

@@ -3131,17 +3141,7 @@

Error handling

  • Manual Rule Approval Blocked
  • Invalid Object
    • -

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ],
    • "account": "string",
    • "copies": 0,
    • "rse_expression": "string",
    • "grouping": "string",
    • "weight": 0,
    • "lifetime": 0,
    • "locked": true,
    • "subscription_id": "string",
    • "sourse_replica_expression": "string",
    • "activity": "string",
    • "notify": "string",
    • "purge_replicas": true,
    • "ignore_availability": true,
    • "comments": "string",
    • "ask_approval": true,
    • "asynchronous": true,
    • "priority": 0,
    • "split_container": true,
    • "meta": "string"
    }

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Return all rules for a given account

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/rules/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    "string"

    Return all locks for a Rule

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ],
    • "account": "string",
    • "copies": 0,
    • "rse_expression": "string",
    • "grouping": "string",
    • "weight": 0,
    • "lifetime": 0,
    • "locked": true,
    • "subscription_id": "string",
    • "sourse_replica_expression": "string",
    • "activity": "string",
    • "notify": "string",
    • "purge_replicas": true,
    • "ignore_availability": true,
    • "comments": "string",
    • "ask_approval": true,
    • "asynchronous": true,
    • "priority": 0,
    • "split_container": true,
    • "meta": "string"
    }

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Return all locks for a Rule

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    The id of the replication rule.

    Responses

    Response samples

    Content type
    application/json
    [
    • "string"
    ]