API Documentation
Set Admin Credentials...
Storage Endpoint GET

get

Storage Endpoint GET

Retrieves metadata and details about the exact storage endpoint (StorageVault) identified by the endpoint’s GUID.
Required Scope: Files/Folder Metadata, Read

 

URL Parameters

  • Param Name
    Type
    Description
  • ENDPOINT_ID
    string
    Unique ID associated with the storage endpoint (Guid)

Resource URL

https://api.syncplicity.com/ storage/storageendpoint.svc/{ENDPOINT_ID}

Header Parameters

Name Values Description
Accept
(required)

application/json

AppKey
(required)

Consumer Key of the app from Developer Portal

As-User

A Global Administrator, or
eDiscovery Administrator who has been
assigned the corresponding privilege, can
enter another user’s GUID so that all
Content API actions are performed on
behalf of that user.
If this header is not used or
the Administrator has not been assigned
the corresponding privilege, the API works
on behalf of the currently authenticated
Global or eDiscovery Administrator.

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...
Reset
Request Response cURL

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

	

	
	

		
Response Payload Schema

		
	
		
	





Response Error Details


    
    
  • 
        
    HTTP Code
    
        
    Error Code
    
        
    Description
    
    
    • 
    
    
  • 
        
    
            400
        
    
        
    
            400
        
    
        
    
            
    
                (Bad request) – Invalid input
            
    
        
    
    
    • 
    
    
  • 
        
    
            401
        
    
        
    
            401
        
    
        
    
            
    
                (Unauthorized) - Not
    Authorized
            
    
        
    
    
    • 
    
    
  • 
        
    
            403
        
    
        
    
            403
        
    
        
    
            
    
                (Forbidden) - The caller is attempting to obtain StorageVault information not as an administrator
    (Forbidden) - user Not Authorized For Action
    (Forbidden) - Request Came From An Unapproved IP Address
            
    
        
    
    
    • 
    
    
  • 
        
    
            404
        
    
        
    
            404
        
    
        
    
            
    
                (Not found) - Storage Endpoint Not Found or Owner Does Not Exist or Invalid Storage Endpoint ID
            
    
        
    
    
    • 
    











    
Working...