Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
968 changes: 968 additions & 0 deletions src/pages/ipa/resources/accounts.mdx

Large diffs are not rendered by default.

1,878 changes: 1,878 additions & 0 deletions src/pages/ipa/resources/dns.mdx

Large diffs are not rendered by default.

563 changes: 563 additions & 0 deletions src/pages/ipa/resources/events.mdx

Large diffs are not rendered by default.

364 changes: 364 additions & 0 deletions src/pages/ipa/resources/geo-locations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,364 @@
export const title = 'Geo Locations'



## List all country codes {{ tag: 'GET' , label: '/api/locations/countries' }}

<Row>
<Col>
Get list of all country in 2-letter ISO 3166-1 alpha-2 codes
</Col>

<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/locations/countries">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/locations/countries \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```

```js
const axios = require('axios');

let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/locations/countries',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
};

axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```

```python
import requests
import json

url = "https://api.netbird.io/api/locations/countries"

headers = {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

```go
package main

import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)

func main() {

url := "https://api.netbird.io/api/locations/countries"
method := "GET"

client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)

if err != nil {
fmt.Println(err)
return
{

req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()

body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```

```ruby
require "uri"
require "json"
require "net/http"

url = URI("https://api.netbird.io/api/locations/countries")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"

response = https.request(request)
puts response.read_body
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();

Request request = new Request.Builder()
.url("https://api.netbird.io/api/locations/countries")
.method("GET")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/locations/countries',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

</CodeGroup>


<CodeGroup title="Response">
```json {{ title: 'Example' }}
[
"DE"
]
```
```json {{ title: 'Schema' }}
[
"string"
]
```
</CodeGroup>


</Col>
</Row>

---


## List all city names by country {{ tag: 'GET' , label: '/api/locations/countries/{country}/cities' }}

<Row>
<Col>
Get a list of all English city names for a given country code

### Path Parameters
<Properties>

<Property name="country" type="string" required={true}>

</Property>
</Properties>
</Col>

<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/locations/countries/{country}/cities">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/locations/countries/{country}/cities \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```

```js
const axios = require('axios');

let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/locations/countries/{country}/cities',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
};

axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```

```python
import requests
import json

url = "https://api.netbird.io/api/locations/countries/{country}/cities"

headers = {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

```go
package main

import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)

func main() {

url := "https://api.netbird.io/api/locations/countries/{country}/cities"
method := "GET"

client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)

if err != nil {
fmt.Println(err)
return
{

req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()

body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```

```ruby
require "uri"
require "json"
require "net/http"

url = URI("https://api.netbird.io/api/locations/countries/{country}/cities")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"

response = https.request(request)
puts response.read_body
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();

Request request = new Request.Builder()
.url("https://api.netbird.io/api/locations/countries/{country}/cities")
.method("GET")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/locations/countries/{country}/cities',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

</CodeGroup>


<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"geoname_id": 2950158,
"city_name": "Berlin"
}
```
```json {{ title: 'Schema' }}
{
"geoname_id": "integer",
"city_name": "string"
}
```
</CodeGroup>


</Col>
</Row>

---
Loading