Search…
Connectors
A Connector is an adapter that connects external arbitrary infrastructure with Provide.

List Connectors

Token should be Application type
curl
1
curl -i \
2
-H 'Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
3
https://nchain.provide.services/api/v1/connectors
4
HTTP/2 200
Copied!
Response JSON:
1
[
2
{
3
"id":"e7ceec61-dae7-4697-aa5a-a6868fbb89ca",
4
"created_at":"2019-09-17T16:03:35.397391-04:00",
5
"application_id":"a1ed9f4b-0770-44d5-a5e5-c9625fe3480f",
6
"network_id":"aa51a87f-f142-4341-8e94-b4b0214a009f",
7
"name":"IPFS us-east-1",
8
"type":"ipfs",
9
"status":"init",
10
"description":null,
11
"config":{
12
"api_port":5001,
13
"container":"providenetwork-node",
14
"gateway_port":8080,
15
"provider_id":"docker",
16
"region":"us-east-1",
17
"role":"peer",
18
"security":{
19
"egress":"*",
20
"ingress":{
21
"0.0.0.0/0":{
22
"tcp":[
23
5001,
24
8080
25
],
26
"udp":null
27
}
28
}
29
},
30
"target_id":"aws"
31
},
32
"accessed_at":null
33
}
34
]
Copied!
List configured connectors.

Create Connector

Token should be Application type
curl
1
curl -i \
2
-H 'Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
3
https://nchain.provide.services/api/v1/connectors --data-binary @- << EOF
4
{
5
"name":"demoIPFS",
6
"network_id":"66d44f30-9092-4182-a3c4-bc02736d6ae5",
7
"type":"ipfs",
8
"config":{
9
"region":"us-east-1",
10
"target_id":"aws",
11
"provider_id":"docker",
12
"role":"peer",
13
"container":"providenetwork-ipfs",
14
"rpc_port":5001,
15
"gateway_port":8080,
16
"credentials":{
17
"aws_access_key_id":"AKIAXXXXXXXXXXXXXXXX",
18
"aws_secret_access_key":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
19
},
20
"security":{
21
"egress":"*",
22
"ingress":{
23
"0.0.0.0/0":{
24
"tcp":[
25
5001,
26
8080
27
],
28
"udp":[]
29
}
30
}
31
}
32
}
33
}
34
EOF
Copied!
Response JSON:
1
{
2
"id":"e7ceec61-dae7-4697-aa5a-a6868fbb89ca",
3
"created_at":"2019-09-17T16:03:35.397391-04:00",
4
"application_id":"a1ed9f4b-0770-44d5-a5e5-c9625fe3480f",
5
"network_id":"66d44f30-9092-4182-a3c4-bc02736d6ae5",
6
"name":"IPFS us-east-1",
7
"type":"ipfs",
8
"status":"init",
9
"description":null,
10
"config":{
11
"api_port":5001,
12
"container":"providenetwork-node",
13
"gateway_port":8080,
14
"provider_id":"docker",
15
"region":"us-east-1",
16
"role":"peer",
17
"security":{
18
"egress":"*",
19
"ingress":{
20
"0.0.0.0/0":{
21
"tcp":[
22
5001,
23
8080
24
],
25
"udp":null
26
}
27
}
28
},
29
"target_id":"aws"
30
},
31
"accessed_at":null
32
}
Copied!
Create a new connector using the given configuration.

Retrieve Connector Details

Documentation forthcoming.

URL Parameters

Parameter
Description
id
id of the Connector

Delete Connector

1
curl -i -XDELETE \
2
-H 'Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
3
https://nchain.provide.services/api/v1/connectors/9e5e269a-f074-49e2-8383-ab94a33ae30a
4
HTTP/2 204
Copied!
Delete a configured connector.

URL Parameters

Parameter
Description
id
id of the Connector
Last modified 4mo ago