From 60c6337a655d954bddd34832efecdcb16c0b69bc Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Mon, 29 Apr 2024 04:19:16 +0000 Subject: [PATCH] Documentation autoupdate --- html/rest_api_doc.html | 450 ++--- yaml/rest_api_doc_spec.yaml | 3504 +++++++++++++++++------------------ 2 files changed, 1977 insertions(+), 1977 deletions(-) diff --git a/html/rest_api_doc.html b/html/rest_api_doc.html index 82ca2ec856e..1bb8060d53d 100644 --- a/html/rest_api_doc.html +++ b/html/rest_api_doc.html @@ -2264,7 +2264,7 @@ -
Rucio logo
API docs by Redocly
Rucio logo
API docs by Redocly
Error handling

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
{ }

Create identity

Grant an account identity access to an account.

+ --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
[
  • [
    ]
]

Create identity

Grant an account identity access to an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

Request Body schema: application/json
identity
required
string

The identity.

authtype
required
string

The authtype.

@@ -2412,15 +2420,7 @@

Error handling

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
[
  • [
    ]
]

Delete identity

Delete an account identity.

+

Request samples

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

Response samples

Content type
application/json
"Created"

Delete identity

Delete an account identity.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

Request Body schema: application/json
identity
required
string

The identity.

authtype
required
string

The authtype.

@@ -2462,37 +2462,37 @@

Error handling

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
[
  • {
    }
]

Create

Create an account.

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

Response samples

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

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 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
{
  • "type": "USER",
  • "email": "string"
}

Response samples

Content type
application/json
"Created"

List account parameters

Lists all parameters for an account.

+

Request samples

Content type
application/json
{ }

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 \
+

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.

+ --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"
}

Create

Create 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"

Delete

Delete an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

Responses

Request samples 

curl --request DELETE \
+

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/accounts/{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
object

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

-

Responses

Request samples

Content type
application/json
{ }

List

List all accounts.

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

List

List all accounts.

Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
@@ -2575,19 +2575,19 @@ 
Error handling

Request samples 

curl --request OPTIONS \
   --url http://undefinedundefined/auth/ssh_challenge_token \
-  --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

Authenticate a Rucio account via SAML.

+ --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'

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 Allow cross-site scripting

SAML Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Create

Create or set the configuration option in the requested section.

+

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'}}.

Responses

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

Sign URL

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

+

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.

lifetime
string

The lifetime, default 600s.

svc
string

The service, default gcs.

@@ -2792,7 +2792,15 @@

Error handling

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
[
  • {
    }
]

Add dids to did

Append data identifiers to data identifiers.

+ --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
[
  • {
    }
]

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.

Request Body schema: application/json
rse
string

The name of the rse.

account
string

The account which attaches the dids.

@@ -2802,38 +2810,30 @@

Error handling

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.

-
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.

+

Request samples

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

Response samples

Content type
application/json
"Created"

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.

Request Body schema: application/json
required
Array of objects

The dids to detach.

Responses

Request samples

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

Add metadata

Add metadata to a did.

-
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

-
Request Body schema: application/json
meta
required
object

The metadata to add. A dictionary containg the metadata name as key and the value as value.

-
recursive
boolean
Default: false

Flag if the metadata should be applied recirsively to children.

-

Responses

Request samples

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

Response samples

Content type
application/json
"Created"

Get metadata

Get the metadata of a did.

+

Request samples

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

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 \
+

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.

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

Response samples

Content type
application/json
{ }

Add metadata

Add metadata to a did.

+
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

+
Request Body schema: application/json
meta
required
object

The metadata to add. A dictionary containg the metadata name as key and the value as value.

+
recursive
boolean
Default: false

Flag if the metadata should be applied recirsively to children.

+

Responses

Request samples

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

Response samples

Content type
application/json
"Created"

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.

query Parameters
key
string

The key to delete.

Responses

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
[
  • {
    }
]

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.

-
Request Body schema: application/json
account
required
string

The account to follow the did.

-

Responses

Request samples

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

Get followers

Get all followers for a specific did.

+ --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 \
+

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

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

Response samples

Content type
application/json
[
  • {
    }
]

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.

+
Request Body schema: application/json
account
required
string

The account to follow the did.

+

Responses

Request samples

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

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.

Request Body schema: application/json
account
required
string

The account to unfollow the did.

Responses

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

Name of the executable.

+ --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.

pid
integer

UNIX Process ID as a number, e.g., 1234.

older_than
integer

Ignore specified heartbeats older than specified nr of seconds.

@@ -3020,13 +3026,7 @@

Error handling

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

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

+

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.

query Parameters
X-Rucio-Username
required
string

Username for the identity.

X-Rucio-Password
required
string

The password for the identity.

@@ -3063,7 +3063,14 @@

Error handling

Array of objects

Account data.

Responses

Request samples

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

Response samples

Content type
application/json
"Created"

Lifetime Exceptions

Create Exception

Creates a Lifetime 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.

pattern
string

The pattern of the lifetime exception.

comments
string

The comment for the lifetime exception.

@@ -3072,29 +3079,22 @@

Error handling

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

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

Response samples

Content type
application/json
"string"

Approve/Reject exception

Approve/Reject a Lifetime Exception.

+
Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the Lifetime Exception.

+
Request Body schema: application/json
state
string
Enum: "A" "R"

The new state for the Lifetime Exception.

+

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

Get a single Lifetime Exception.

+

Request samples

Content type
application/json
{
  • "state": "A"
}

Response samples

Content type
application/json
"Created"

Get Exception

Get a single Lifetime Exception.

Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the lifetime exception.

Responses

Request samples 

curl --request GET \
+

Request samples 

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

Response samples

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

Approve/Reject exception

Approve/Reject a Lifetime Exception.

-
Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the Lifetime Exception.

-
Request Body schema: application/json
state
string
Enum: "A" "R"

The new state for the Lifetime Exception.

-

Responses

Request samples

Content type
application/json
{
  • "state": "A"
}

Response samples

Content type
application/json
"Created"

Lock

Get locks by rse

Get all dataset locks for an associated rse.

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

Response samples

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

Lock

Get locks by rse

Get all dataset locks for an associated rse.

Authorizations:
AuthToken
path Parameters
rse
required
string

The rse name.

Request Body schema: application/json
did_type
string
Value: "dataset"

The did type to filter for.

Responses

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

Creates a new value for a 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.

Request Body schema: application/json
value
required
string

The new value associated with a key.

Responses

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

Creates a new allowed key (value is NULL).

+

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.

Request Body schema: application/json
key_type
string

The key tpye.

value_type
string

The value type.

@@ -3147,7 +3147,14 @@

Error handling

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

Creates a new value for a 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.

Request Body schema: application/json
value
required
string

The new value associated with a key.

Responses

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

Ping the server and get data about it.

+

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 \
@@ -3222,14 +3222,7 @@ 
Error handling

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

List the suspicious replicas on a list of RSEs.

+ --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.

younger_than
string

Date to filter for.

nattempts
integer

The maximum number of attempts to make.

@@ -3237,9 +3230,16 @@

Error handling

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

List the bad or suspicious 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.

rse
string

The rse name.

younger_than
string <date-time>

Date to select bad replicas younger than this date.

@@ -3368,33 +3368,33 @@

Error handling

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

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

Response samples

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

Update subscription

Update an existing 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 subcription.

-

Responses

Responses

Request samples

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

Response samples

Content type
application/json
"string"

Get Subscription

Retrieve a subscription.

+

Request samples

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

Get Subscription

Retrieve a subscription.

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

name
required
string

The subscription name.

Responses

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

Update an existing subscription.

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

Response samples

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

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 subcription.

-

Responses

Responses

Request samples

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

Get Subscription by Name

Retrieve a subscription by name.

+

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.

Responses

Request samples 

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

Create Rse Distance

Post a rse distance.

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

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.

-
Request Body schema: application/json
distance
integer

The distance between RSEs.

+
Request Body schema: application/json
distance
integer

The distance between the 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

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.

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
[
  • {
    }
]

Delete Rse Distance

Delete distance information between source RSE and destination RSE.

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

Response samples

Content type
application/json
[
  • {
    }
]

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.

-

Responses

Request Body schema: application/json
distance
integer

The distance between RSEs.

+
ranking
integer
Deprecated

Same as distance.

+

Responses

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.

+

Request samples

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

Response samples

Content type
application/json
"Created"

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 the RSEs.

-
ranking
integer
Deprecated

Same as distance.

-

Responses

Responses

Request samples

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

Response samples

Content type
application/json
"Created"

Delete Protocol Attributes

Delete all protocol attibutes.

+

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 Protocol Attributes

Updates attributes of an existing protocol entry. Because protocol identifier, hostname, and port are used as unique identifier they are immutable.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

scheme
required
string

The protocol identifier.

hostname
required
string

The hostname of the protocol.

port
required
integer

The port of the protocol.

-

Responses

Responses

Request samples 

curl --request DELETE \
+

Request samples 

curl --request PUT \
   --url http://undefinedundefined/rses/{rse}/protocols/{scheme}/{hostname}/{port} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update Protocol Attributes

Updates attributes of an existing protocol entry. Because protocol identifier, hostname, and port are used as unique identifier they are immutable.

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

Response samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "staging_area": "string",
  • "rse_type": "DISK",
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "credentials": "string",
  • "domain": [ ],
  • "id": "string",
  • "lfn2pfn_algorithm": "string",
  • "qos_class": "string",
  • "rse": "string",
  • "sign_url": "string",
  • "verify_checksum": true,
  • "protocols": [
    ]
}

Delete Protocol Attributes

Delete all protocol attibutes.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

scheme
required
string

The protocol identifier.

hostname
required
string

The hostname of the protocol.

port
required
integer

The port of the protocol.

-

Responses

Responses

Request samples 

curl --request PUT \
+

Request samples 

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

Response samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "staging_area": "string",
  • "rse_type": "DISK",
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "credentials": "string",
  • "domain": [ ],
  • "id": "string",
  • "lfn2pfn_algorithm": "string",
  • "qos_class": "string",
  • "rse": "string",
  • "sign_url": "string",
  • "verify_checksum": true,
  • "protocols": [
    ]
}

List RSE Protocols

List all supported protocols of the given RSE.

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

List RSE Protocols

List all supported protocols of the given 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}/accounts/usage \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Get Rse Usage Information

Get rse usage information.

-
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
query Parameters
per_account
boolean

Boolean whether the usage should be also calculated per account or not.

-
source
string

The information source, e.g., srm.

-

Responses

Request samples 

curl --request GET \
-  --url 'http://undefinedundefined/rses/{rse}/usage?per_account=SOME_BOOLEAN_VALUE&source=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Update Rse Usage

Update the RSE Update information.

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

Response samples

Content type
application/json
[
  • {
    }
]

Update Rse Usage

Update the RSE Update information.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

Request Body schema: application/json
source
string

The information source, e.g. srm.

used
integer

The number of used bytes.

@@ -3577,38 +3567,48 @@

Error handling

Request samples

Content type
application/json
{
  • "source": "string",
  • "used": 0,
  • "free": 0,
  • "files": 0
}

Get Rse Usage History

Get the rse usage history

+

Request samples

Content type
application/json
{
  • "source": "string",
  • "used": 0,
  • "free": 0,
  • "files": 0
}

Get Rse Usage Information

Get rse usage information.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

+
query Parameters
per_account
boolean

Boolean whether the usage should be also calculated per account or not.

+
source
string

The information source, e.g., srm.

Responses

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
[
  • {
    }
]

Get Rse Limits

Get the rse limits.

+

Request samples 

curl --request GET \
+  --url 'http://undefinedundefined/rses/{rse}/usage?per_account=SOME_BOOLEAN_VALUE&source=SOME_STRING_VALUE' \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Get Rse Usage History

Get the rse usage history

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
}

Delete Rse Limit

Delete an rse limit

+

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
[
  • {
    }
]

Update Rse Limit

Update an rse limit.

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.

+
Request Body schema: application/json
name
string

The name of the limit.

+
value
integer

The value of the limit.

Responses

Request samples

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

Update Rse Limit

Update an rse limit.

+

Request samples

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

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
string

The name of the limit.

-
value
integer

The value of the limit.

+

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
}

Delete Rse Limit

Delete an rse limit

+
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",
  • "value": 0
}

Add QoS policy

Add a QoS Policy to a RSE.

+

Request samples

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

Add QoS policy

Add a QoS Policy to a RSE.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

policy
required
string

The QoS policy to add to and rse.

Responses

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/rses/{rse}/qos_policy/{policy} \
-  --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

If the pfn is generated deterministicly.

+
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.

city
string

The city of the RSE.

staging_area
string

Staging area.

region_code
string

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.

latitute
number

The latitute of the RSE.

-
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.

+
longitude
number

The longitude of the RSE.

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",
  • "latitute": 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.

+

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",
  • "latitute": 0,
  • "longitude": 0
}

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",
  • "latitute": 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.

-

Responses

Request samples 

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

Update RSE

Update RSE properties.

+ --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",
  • "latitute": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": 0,
  • "availability_write": 0,
  • "availability_delete": null
}

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

If the pfn is generated deterministicly.

+
Request Body schema: application/json
deterministic
boolean

If the pfn is generated deterministicly.

volatile
boolean

RSE cache.

city
string

The city of the RSE.

staging_area
string

Staging area.

region_code
string

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.

latitute
number

The latitute of the RSE.

-
longitude
number

The longitude of the RSE.

+
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",
  • "latitute": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true
}

Response samples

Content type
application/json
"Created"

Disable RSE

Disable a specific RSE.

+
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

+

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",
  • "latitute": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
"Created"

List RSEs

Lists all RSEs.

+

Request samples 

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

List RSEs

Lists all RSEs.

Authorizations:
AuthToken
query Parameters
expression
string

RSE expression to select RSEs.

Responses

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

Return a Rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

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

Response samples

Content type
application/json
[
  • {
    }
]

Rule

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.

+
required
object

The parameters to change.

+

Responses

Request samples

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

Return a 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 GET \
   --url http://undefinedundefined/rules/{rule_id} \
-  --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.

+ --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 DELETE \
+

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/rules/{rule_id} \
-  --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.

-
required
object

The parameters to change.

-

Responses

Return all rules for a given account

Authorizations:
AuthToken

Responses

Request samples

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

Create a new replication rule

Authorizations:
AuthToken
Request Body schema: application/json

Parameters for the new rule.

+

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.

account
required
string

The account of the issuer.

copies
required
integer

The number of replicas.

@@ -3748,13 +3754,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

    The id of the replication rule.

    +

    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"
    ]