# \SitesApi

All URIs are relative to *http://localhost:5000*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_site**](SitesApi.md#create_site) | **POST** /v3/streams/projects/{project_id}/sites | Create a site. (single or bulk)
[**delete_site**](SitesApi.md#delete_site) | **DELETE** /v3/streams/projects/{project_id}/sites/{site_id} | Delete a site
[**get_site**](SitesApi.md#get_site) | **GET** /v3/streams/projects/{project_id}/sites/{site_id} | Get site details.
[**list_sites**](SitesApi.md#list_sites) | **GET** /v3/streams/projects/{project_id}/sites | List sites.
[**update_site**](SitesApi.md#update_site) | **PUT** /v3/streams/projects/{project_id}/sites/{site_id} | Update a site



## create_site

> models::ListSites200Response create_site(project_id, new_site)
Create a site. (single or bulk)

Create a site. (single or bulk)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**new_site** | [**Vec<models::NewSite>**](NewSite.md) |  | [required] |

### Return type

[**models::ListSites200Response**](list_sites_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_site

> models::GetSite200Response delete_site(project_id, site_id)
Delete a site

Delete a site

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**site_id** | **String** | User uniquely defined ID for site. | [required] |

### Return type

[**models::GetSite200Response**](get_site_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_site

> models::GetSite200Response get_site(project_id, site_id)
Get site details.

Get site details.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**site_id** | **String** | User uniquely defined ID for site. | [required] |

### Return type

[**models::GetSite200Response**](get_site_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_sites

> models::ListSites200Response list_sites(project_id, query, limit, skip)
List sites.

List sites.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**query** | Option<**String**> | a formated query string for sites. |  |
**limit** | Option<**i32**> | limit the number of records returned. |  |
**skip** | Option<**i32**> | index (skip) to start list. |  |

### Return type

[**models::ListSites200Response**](list_sites_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_site

> models::GetSite200Response update_site(project_id, site_id, update_site)
Update a site

Update a site

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**site_id** | **String** | User uniquely defined ID for site. | [required] |
**update_site** | [**UpdateSite**](UpdateSite.md) |  | [required] |

### Return type

[**models::GetSite200Response**](get_site_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

