diff --git a/html/rest_api_doc.html b/html/rest_api_doc.html index 1bf17e2272..1e828f243e 100644 --- a/html/rest_api_doc.html +++ b/html/rest_api_doc.html @@ -426,7 +426,7 @@ -
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
[
  • {
    }
]

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

Delete

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

Response samples

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

Delete

Delete an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -806,9 +792,9 @@

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

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

Create

Create an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -824,7 +810,7 @@

Error handling

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

Invalid Auth Token

Request samples

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

Response samples

Content type
application/json
"Created"

List account parameters

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.

@@ -836,9 +822,23 @@

Error handling

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

No account found.

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

List

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

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

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

Approve/Reject exception

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

Response samples

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

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

@@ -1888,21 +1902,7 @@

Error handling

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

Invalid Auth Token

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 \
-  --url http://undefinedundefined/lifetime_exceptions/{exception_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Lock

Get locks by rse

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.

Authorizations:
AuthToken
path Parameters
rse
required
string

The rse name.

@@ -2419,23 +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
]

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

-

Responses

Request samples

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

Create subscription

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

@@ -2453,7 +2437,7 @@

Error handling

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

Not found

Request samples

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

Response samples

Content type
application/json
"string"

Get Subscription

Request samples

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

Response samples

Content type
application/json
"string"

Get Subscription

Retrieve a subscription.

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

@@ -2467,9 +2451,25 @@

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

Get Subscription by Name

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

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

Get Subscription by Name

Retrieve a subscription by name.

Authorizations:
AuthToken
path Parameters
name
required
string

The subscription name.

@@ -2611,25 +2611,7 @@

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"

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

Delete Rse Distance

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.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

@@ -2643,9 +2625,9 @@

Error handling

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

Rse not found

Request samples

curl --request DELETE \
+

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"

Create Rse Distance

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

Response samples

Content type
application/json
"Deleted"

Create Rse Distance

Post a rse distance.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

@@ -2663,7 +2645,7 @@

Error handling

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

Rse not found

Request samples

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

Response samples

Content type
application/json
"Created"

Get Rse Distances

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.

@@ -2677,10 +2659,28 @@

Error handling

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

Rse not found

Request samples

curl --request GET \
+

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

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

Delete Protocol Attributes

Delete all protocol attributes.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

scheme
required
string
Error handling " class="sc-epnzzT sc-eMwmJz drsioI ewnBNs">

The hostname of the protocol.

port
required
integer

The port of the protocol.

-

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": [
    ]
}

Delete Protocol Attributes

Delete all protocol attributes.

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

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

scheme
required
string
Error handling " class="sc-epnzzT sc-eMwmJz drsioI ewnBNs">

The hostname of the protocol.

port
required
integer

The port of the protocol.

-

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'

List RSE Protocols

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

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2767,7 +2767,25 @@

Error handling

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

Not acceptable

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

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

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2789,25 +2807,7 @@

Error handling

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

Rse not found

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

Request samples

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

Get Rse Usage History

Get the rse usage history

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2821,14 +2821,12 @@

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

Update Rse Limit

Update an rse limit.

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

Response samples

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

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
string
Request Body schema: application/json
name
required
string

The name of the limit.

-
value
integer

The value of the limit.

Responses

Request samples

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

Delete Rse Limit

Delete an rse limit

+

Request samples

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

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
}

Update Rse Limit

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

Delete QoS Policy

Request samples

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

Delete QoS Policy

Delete QoS policy from RSE.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2897,45 +2897,7 @@

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"

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

-
time_zone
string

The time zone of the RSE.

-
rse_type
string
Enum: "DISK" "TAPE"

The rse type.

-
latitude
number

The latitude of the RSE.

-
longitude
number

The longitude of the RSE.

-

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"

Disable RSE

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

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.

@@ -2945,9 +2907,9 @@

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

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

Create RSE

Creates a RSE with all the metadata.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2995,7 +2957,7 @@

Error handling

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

RSE not found

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

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.

@@ -3007,9 +2969,47 @@

Error handling

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

RSE not found

Request samples

curl --request GET \
+

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
}

List RSEs

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

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

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

+
time_zone
string

The time zone of the RSE.

+
rse_type
string
Enum: "DISK" "TAPE"

The rse type.

+
latitude
number

The latitude of the RSE.

+
longitude
number

The longitude of the RSE.

+

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

Lists all RSEs.

Authorizations:
AuthToken
query Parameters
expression
string

RSE expression to select RSEs.

@@ -3023,41 +3023,41 @@

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

Update the replication rules parameters

Authorizations:
AuthToken
path Parameters
rule_id
required
string
--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

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

Delete a replication rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

Request samples

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

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"

Update the replication rules parameters

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

-

Responses

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"

Create a new replication rule

Authorizations:
AuthToken
Request Body schema: application/json

Request samples

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

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.

@@ -3249,7 +3249,7 @@

Error handling

--url http://undefinedundefined/scopes/{account}/scopes \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • "string"
]