You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The user is not allowed to modify the configuration
GET /config/authorize
List granted accesses
Query arguments
Name
Type
Required
Description
operation
string
False
Filter by operation
dn
string
False
Filter by DN
Responses
Code
Description
403
The user is not allowed to query the configuration
DELETE /config/authorize
Revoke access for a DN for a given operation, or all
Query arguments
Name
Type
Required
Description
operation
string
False
The operation to be removed
dn
string
True
The user DN to be removed
Responses
Code
Description
403
The user is not allowed to modify the configuration
Configuration of cloud storages
GET /config/cloud_storage
Get a list of cloud storages registered
Responses
Code
Description
403
The user is not allowed to modify the configuration
POST /config/cloud_storage
Add or modify a cloud storage entry
Responses
Code
Description
403
The user is not allowed to modify the configuration
DELETE /config/cloud_storage/{storage_name}/{id}
Delete credentials for a given user/vo
Path arguments
Name
Type
storage_name
string
id
string
Responses
Code
Description
403
The user is not allowed to modify the configuration
GET /config/cloud_storage/{storage_name}
Get a list of users registered for a given storage name
Path arguments
Name
Type
storage_name
string
Responses
Code
Description
403
The user is not allowed to modify the configuration
DELETE /config/cloud_storage/{storage_name}
Remove a registered cloud storage
Path arguments
Name
Type
storage_name
string
Responses
Code
Description
403
The user is not allowed to modify the configuration
POST /config/cloud_storage/{storage_name}
Add a user or a VO credentials to the storage
Path arguments
Name
Type
storage_name
string
Responses
Code
Description
403
The user is not allowed to modify the configuration
Drain operations
POST /config/drain
Set the drain status of a server
Responses
Code
Description
403
The user is not allowed to change the configuration
400
Bad request. Invalid host or invalid drain value
Server-wide configuration
POST /config/global
Set the global configuration
Responses
Code
Description
403
The user is not allowed to query the configuration
400
Invalid values passed in the request
GET /config/global
Get the global configuration
Responses
Code
Description
403
The user is not allowed to query the configuration
400
Invalid values passed in the request
DELETE /config/global
Delete the global configuration for the given VO
Responses
Code
Description
403
The user is not allowed to query the configuration
400
Invalid values passed in the request
Link configuration
GET /config/links/{sym_name}
Get the existing configuration for a given link
Path arguments
Name
Type
sym_name
string
Responses
Code
Description
404
The group or the member does not exist
403
The user is not allowed to query the configuration
DELETE /config/links/{sym_name}
Deletes an existing link configuration
Path arguments
Name
Type
sym_name
string
Responses
Code
Description
404
The group or the member does not exist
403
The user is not allowed to query the configuration
204
Link removed
POST /config/links
Set the configuration for a given link
Responses
Code
Description
403
The user is not allowed to query the configuration
400
Invalid values passed in the request
GET /config/links
Get a list of all the links configured
Responses
Code
Description
403
The user is not allowed to query the configuration
Grid storage configuration
POST /config/se
Set the configuration parameters for a given SE
Responses
Code
Description
403
The user is not allowed to query the configuration
400
Invalid values passed in the request
GET /config/se
Get the configurations status for a given SE
Query arguments
Name
Type
Required
Description
se
string
False
Storage element
Responses
Code
Description
403
The user is not allowed to query the configuration
DELETE /config/se
Delete the configuration for a given SE
Query arguments
Name
Type
Required
Description
se
string
True
Storage element
Responses
Code
Description
403
The user is not allowed to modify the configuration
VO Share configuration
POST /config/shares
Add or modify a share
Responses
Code
Description
403
The user is not allowed to modify the configuration
GET /config/shares
List the existing shares
Responses
Code
Description
403
The user is not allowed to query the configuration
DELETE /config/shares
Delete a share
Responses
Code
Description
403
The user is not allowed to modify the configuration
Data management operations
POST /dm/unlink
Remove a remote file
Query arguments
Name
Type
Required
Description
surl
string
True
Remote SURL
Responses
Code
Description
500
Internal error
503
Try again later
419
The credentials need to be re-delegated
404
The SURL does not exist
403
Permission denied
400
Protocol not supported OR the SURL is not a directory
POST /dm/rename
Stat a remote file
Query arguments
Name
Type
Required
Description
new
string
True
New SURL name
old
string
True
Old SURL name
Responses
Code
Description
500
Internal error
503
Try again later
419
The credentials need to be re-delegated
404
The SURL does not exist
403
Permission denied
400
Protocol not supported OR the SURL is not a directory
POST /dm/rmdir
Remove a remote folder
Query arguments
Name
Type
Required
Description
surl
string
True
Remote SURL
Responses
Code
Description
500
Internal error
503
Try again later
419
The credentials need to be re-delegated
404
The SURL does not exist
403
Permission denied
400
Protocol not supported OR the SURL is not a directory
POST /dm/mkdir
Create a remote file
Query arguments
Name
Type
Required
Description
surl
string
True
Remote SURL
Responses
Code
Description
500
Internal error
503
Try again later
419
The credentials need to be re-delegated
404
The SURL does not exist
403
Permission denied
400
Protocol not supported OR the SURL is not a directory
GET /dm/stat
Stat a remote file
Query arguments
Name
Type
Required
Description
surl
string
True
Remote SURL
Responses
Code
Description
500
Internal error
503
Try again later
419
The credentials need to be re-delegated
404
The SURL does not exist
403
Permission denied
400
Protocol not supported OR the SURL is not a directory
GET /dm/list
List the content of a remote directory
Query arguments
Name
Type
Required
Description
surl
string
True
Remote SURL
Responses
Code
Description
500
Internal error
503
Try again later
419
The credentials need to be re-delegated
404
The SURL does not exist
403
Permission denied
400
Protocol not supported OR the SURL is not a directory
Operations to perform the delegation of credentials
GET /whoami
Returns the active credentials of the user
GET /delegation
Render an HTML form to delegate the credentials
PUT /delegation/{dlg_id}/credential
Second step of the delegation process: put the generated certificate
Notes
The certificate being PUT will have to pass the following validation: - There is a previous certificate request done - The certificate subject matches the certificate issuer + '/CN=Proxy' - The certificate modulus matches the stored private key modulus
Path arguments
Name
Type
dlg_id
string
Expected request body
Signed certificate (PEM encoded certificate)
Responses
Code
Description
201
The proxy was stored successfully
400
The proxy failed the validation process
403
The requested delegation ID does not belong to the user
POST /delegation/{dlg_id}/credential
Second step of the delegation process: put the generated certificate
Notes
The certificate being PUT will have to pass the following validation: - There is a previous certificate request done - The certificate subject matches the certificate issuer + '/CN=Proxy' - The certificate modulus matches the stored private key modulus
Path arguments
Name
Type
dlg_id
string
Expected request body
Signed certificate (PEM encoded certificate)
Responses
Code
Description
201
The proxy was stored successfully
400
The proxy failed the validation process
403
The requested delegation ID does not belong to the user
GET /delegation/{dlg_id}/request
First step of the delegation process: get a certificate request
Returns
PEM encoded certificate request
Notes
The returned certificate request must be signed with the user's original credentials.
Path arguments
Name
Type
dlg_id
string
Responses
Code
Description
200
The request was generated succesfully
403
The requested delegation ID does not belong to the user
POST /delegation/{dlg_id}/voms
Generate VOMS extensions for the delegated proxy
Notes
The input must be a json-serialized list of strings, where each strings is a voms command (i.e. ["dteam", "dteam:/dteam/Role=lcgadmin"])
Path arguments
Name
Type
dlg_id
string
Expected request body
List of voms commands (array)
Responses
Code
Description
203
The obtention of the VOMS extensions succeeded
424
The obtention of the VOMS extensions failed
400
Could not understand the request
403
The requested delegation ID does not belong to the user
GET /delegation/{dlg_id}
Get the termination time of the current delegated credential, if any
Returns
dateTime
Path arguments
Name
Type
dlg_id
string
DELETE /delegation/{dlg_id}
Delete the delegated credentials from the database
Path arguments
Name
Type
dlg_id
string
Responses
Code
Description
204
The credentials were deleted successfully
404
The credentials do not exist
403
The requested delegation ID does not belong to the user
GET /whoami/certificate
Returns the user certificate
Operations on Files
GET /files
Get a list of active jobs, or those that match the filter requirements
To prevent heavy queries, only non-terminal (e.g.: ACTIVE) jobs are listed. If 'state_in' argument is requested, make sure to also provide either 'limit' or 'time_window' to get completed jobs
Query arguments
Name
Type
Required
Description
fields
string
False
Return only a subset of the fields
time_window
string
False
For terminal states, limit results to hours[:minutes] into the past
limit
string
False
Limit the number of results
dest_se
string
False
Destination storage element
source_se
string
False
Source storage element
state_in
string
False
Comma separated list of job states to filter. ACTIVE only by default
dlg_id
string
False
Filter by delegation ID
vo_name
string
False
Filter by VO
user_dn
string
False
Filter by user DN
Responses
Code
Description
400
DN and delegation ID do not match
403
Operation forbidden
GET /jobs
Get a list of active jobs, or those that match the filter requirements
To prevent heavy queries, only non-terminal (e.g.: ACTIVE) jobs are listed. If 'state_in' argument is requested, make sure to also provide either 'limit' or 'time_window' to get completed jobs
Query arguments
Name
Type
Required
Description
fields
string
False
Return only a subset of the fields
time_window
string
False
For terminal states, limit results to hours[:minutes] into the past
limit
string
False
Limit the number of results
dest_se
string
False
Destination storage element
source_se
string
False
Source storage element
state_in
string
False
Comma separated list of job states to filter. ACTIVE only by default
dlg_id
string
False
Filter by delegation ID
vo_name
string
False
Filter by VO
user_dn
string
False
Filter by user DN
Responses
Code
Description
400
DN and delegation ID do not match
403
Operation forbidden
PUT /jobs
Submits a new job
Returns
{"job_id": }
Notes
It returns the information about the new submitted job. To know the format for the submission, /api-docs/schema/submit gives the expected format encoded as a JSON-schema. It can be used to validate (i.e in Python, jsonschema.validate)
Expected request body
Submission description (SubmitSchema)
Responses
Code
Description
419
The credentials need to be re-delegated
409
The request could not be completed due to a conflict with the current state of the resource
403
The user doesn't have enough permissions to submit
400
The submission request could not be understood
POST /jobs
Submits a new job
Returns
{"job_id": }
Notes
It returns the information about the new submitted job. To know the format for the submission, /api-docs/schema/submit gives the expected format encoded as a JSON-schema. It can be used to validate (i.e in Python, jsonschema.validate)
Expected request body
Submission description (SubmitSchema)
Responses
Code
Description
419
The credentials need to be re-delegated
409
The request could not be completed due to a conflict with the current state of the resource
403
The user doesn't have enough permissions to submit
400
The submission request could not be understood
DELETE /jobs/all
Cancel all files
Returns
File final states (array if multiple files were given)